Okapi Okapi

Zuora API Credit Balance Adjustment CRUD API removal

Deprecated, no dateSubscribe to Zuora APIShare

Zuora API has deprecated the /v1/object/credit-balance-adjustment* endpoints without announcing a shutdown date. This deprecation stems from a note covering the Invoice Adjustment, Invoice Item Adjustment, and Credit Balance Adjustment features. Once fully retired, requests targeting these endpoints will fail.


Calls it hits

  • /v1/object/credit-balance-adjustment*

What to use instead of these calls

Adjust invoices using POST /v1/creditmemos and POST /v1/debitmemos under Invoice Settlement. Note that adopting credit and debit memos requires enabling the Invoice Settlement feature on the tenant.

Credit and debit memos need the Invoice Settlement feature enabled on the tenant.

In Zuora API's words

added a note for the deprecation of the Invoice Adjustment, Invoice Item Adjustment, and Credit Balance Adjustment features

Zuora API, Announcement

Facts

API
Zuora API rest.zuora.com
Kind
Removal
Announced
April 29, 2024
Takes effect
No date given yet
Calls after that day
Fail
Source
Announcement
Last updated
Verified
, against Zuora API's own pages

Questions

When does this change take effect?

Zuora API deprecated /v1/object/credit-balance-adjustment* without giving a shutdown date yet.

Do these calls still work?

Yes, they still work: Zuora API has not given a shutdown date yet.

How do I find the calls this hits in my code?

Okapi reads your repository, finds the calls this change hits and opens a pull request with the fix. It never commits to your branches: every change comes as a pull request you review.


More from Zuora API 4

  1. No date PUT /v1/orders/{id}Parameter removal Deprecated, no date
  2. No date /v1/object/invoice-adjustment*Removal Deprecated, no date
  3. No date /v1/object/invoice-item-adjustment*Removal Deprecated, no date
  4. No date POST /v1/batch-queryParameter removal Deprecated, no date

Is your code calling this?

Okapi finds the calls this change hits in your repo and opens the pull request with the fix.

Add to GitHub

Get notifications

Subscribe to Zuora API

Hear about each breaking change Zuora API announces, in your feed reader, calendar or Slack.

1What to follow

Provider
  • Zuora API

2Where to get it

/breaking-changes/feed.xml

Paste it into Feedly, Inoreader, NetNewsWire or any reader. New changes show up as they're announced.