Knowledge Center

Knowledge Center > API > REST API > REST API Basics > Responses and Errors

Responses and Errors

HTTP Status

The success or failure of each HTTP request is shown in the status field of the HTTP response header, which contains standard HTTP status codes:

  • a 2xx code for success
  • a 4xx or 5xx code for failure

The header of the response looks something like this:

HTTP/1.1 200 OK
Date: Mon, 01 Apr 2013 01:39:16 GMT
Content-Length: 24768
Content-Type: application/json;charset=utf-8
Connection: close
Server: Apache-Coyote/1.1

The response body, in JSON format, immediately follows the header.

Zuora Responses

REST calls return an HTTP response code of 200 with a JSON body that always contains a "success" field set to either true or false. The success field is suitable for REST call validation while the HTTP response code of 200 is not suitable for error handling.  

When the REST invocation is successful, the JSON formatted response body will report that success is true. The response body may also contain additional data in a JSON array or report other results of the requested action depending on what API endpoint was invoked.  Here is one example:

{
  "success": true,
  "products":  [
     {
      "sku": "SKU-00000443",
      "name": "Gonkulator",
      "description": "Monthly access",
      "productRatePlans":  [...]
    },
  ]
}

If the JSON success field is false, a JSON "reasons" array is included in the response body with at least one set of code and message attributes that can be used to code a response. Here is an example of a response body when success is false:

{

  "success": false,
  "processId": "3F7EA3FD706C7E7C",
  "reasons":  [
    {
      "code": 53100020,
      "message": " {com.zuora.constraints.either_or_both}"
    },
    {
      "code": 53100320,
      "message": "'termType' value should be one of: TERMED, EVERGREEN"
    }
  ]
}

Restricted Access Message

If your tenant has specified allowable IP address ranges for Zuora, the following code and message is returned when a call is sent from an IP address outside the specified range. Contact your tenant administrator at  your organization for assistance. 

   {
      "code": 90000010,
      "message": "Your IP address may be restricted. Please contact the administrator at your company for help"

    }

Error Code Format

The Zuora REST API error code, as in the example above, is eight numeric bytes containing four sub-codes as follows:

Subcode Range Description
entry 1-9 1-digit code for the entry point to the service, e.g., UI, SOAP, or REST. For REST, this is always "5". The entry value default is "9" and is used for authentication faults.
object 001-999 3-digit code for the type of service, e.g., billing, payment, contact, subscription, etc.
field 00-99 2-digit code for a field in the request. Each object code (above) uses a different set of these codes; for instance, 09 means paymentCode in the billing object, but lastName in the contact object. A zero value ("00") typically means the problem is related to the object but not one specific field.
category 01-99 2-digit code that identifies the error, e.g., authentication failure or missing required field

Here is an example error code and message:

    {

      "code": 53100320,
      "message": "'termType' value should be one of: TERMED, EVERGREEN"
    }

In this example error code:

  • The "5" means that this error is returned by the REST service.
  • The next five digits ("31003") identify the object and field associated with the error.
  • The last two digits ("20") indicate a specific type of error, usually explained in the message.

Generally, developers will be chiefly concerned with the 5-digit combination that identifies an object and field.  To understand an error, search for the five-digit (object+field) code in the table below, and consult the list of category codes for the last two digits.

Error Code Listing

If the error message is not clear, you may find information about the error by looking up the error code in the tables below.  The last two digits of the code identify the category code, and the five digits before the category code identify the offending object and field.

Note that in some cases the same 5-digit code may appear more than once, such as some fields for contacts or cardholders. For instance, "10108" identifies the homePhone field for both billToContact and shipToContact.

Category Codes

Code Category
00 Unknown
10 Permission or access denied
11 Authentication failed
20 Invalid format or value
21 Unknown field in request
22 Missing required field
30 Rule restriction
40 Not found
50 Locking contention
60 Internal error
70 Request exceeded limit
90 Malformed request
99 Extension error

Object and Field Codes

These tables list combined 5-digit object-field codes, where the first three digits indicate the object and the last two digits indicate the field. 

100-Object Code Range

Code Request Resource Field
10001 POST v1/accounts accountNumber
10002 POST v1/accounts name
10003 POST v1/accounts currency
10004 POST v1/accounts notes
10005 POST v1/accounts billCycleDay
10006 POST v1/accounts crmId
10007 POST v1/accounts invoiceTemplateId
10008 POST v1/accounts communicationProfileId
10009 POST v1/accounts paymentTerm
10010 POST v1/accounts customFieldsData
10011 POST v1/accounts billToContact
10012 POST v1/accounts soldToContact
10013 POST v1/accounts hpmCreditCardPaymentMethodId
10014 POST v1/accounts creditCard
10015 POST v1/accounts subscription
10016 POST v1/accounts invoiceCollect
10017 POST v1/accounts invoiceTargetDate
10018 POST v1/accounts autoPay
10101 POST v1/accounts billToContact.address1
10101 POST v1/accounts soldToContact.address1
10102 POST v1/accounts billToContact.address2
10102 POST v1/accounts soldToContact.address2
10103 POST v1/accounts billToContact.city
10103 POST v1/accounts soldToContact.city
10104 POST v1/accounts billToContact.country
10104 POST v1/accounts soldToContact.country
10105 POST v1/accounts billToContact.county
10105 POST v1/accounts soldToContact.county
10106 POST v1/accounts billToContact.fax
10106 POST v1/accounts soldToContact.fax
10107 POST v1/accounts billToContact.firstName
10107 POST v1/accounts soldToContact.firstName
10108 POST v1/accounts billToContact.homePhone
10108 POST v1/accounts soldToContact.homePhone
10109 POST v1/accounts billToContact.lastName
10109 POST v1/accounts soldToContact.lastName
10110 POST v1/accounts billToContact.mobilePhone
10110 POST v1/accounts soldToContact.mobilePhone
10111 POST v1/accounts billToContact.nickname
10111 POST v1/accounts soldToContact.nickname
10112 POST v1/accounts billToContact.otherPhone
10112 POST v1/accounts soldToContact.otherPhone
10113 POST v1/accounts billToContact.otherPhoneType
10113 POST v1/accounts soldToContact.otherPhoneType
10114 POST v1/accounts billToContact.personalEmail
10114 POST v1/accounts soldToContact.personalEmail
10115 POST v1/accounts billToContact.zipCode
10115 POST v1/accounts soldToContact.zipCode
10116 POST v1/accounts billToContact.state
10116 POST v1/accounts soldToContact.state
10117 POST v1/accounts billToContact.taxRegion
10117 POST v1/accounts soldToContact.taxRegion
10118 POST v1/accounts billToContact.workEmail
10118 POST v1/accounts soldToContact.workEmail
10119 POST v1/accounts billToContact.workPhone
10119 POST v1/accounts soldToContact.workPhone
10201 POST v1/accounts creditCard.cardType
10202 POST v1/accounts creditCard.cardNumber
10203 POST v1/accounts creditCard.expirationMonth
10204 POST v1/accounts creditCard.expirationYear
10205 POST v1/accounts creditCard.securityCode
10206 POST v1/accounts creditCard.cardHolderInfo
10301 POST v1/accounts creditCard.cardHolderInfo.cardHolderName
10301 POST v1/payment-methods/credit-cards cardHolderInfo.cardHolderName
10302 POST v1/accounts <creditcard.cardholderinfo.addressline1/>
10302 POST v1/payment-methods/credit-cards cardHolderInfo.addressLine1
10303 POST v1/accounts creditCard.cardHolderInfo.addressLine2
10303 POST v1/payment-methods/credit-cards cardHolderInfo.addressLine2
10304 POST v1/accounts creditCard.cardHolderInfo.city
10304 POST v1/payment-methods/credit-cards cardHolderInfo.city
10305 POST v1/accounts creditCard.cardHolderInfo.state
10305 POST v1/payment-methods/credit-cards cardHolderInfo.state
10306 POST v1/accounts creditCard.cardHolderInfo.zipCode
10306 POST v1/payment-methods/credit-cards cardHolderInfo.zipCode
10307 POST v1/accounts creditCard.cardHolderInfo.country
10307 POST v1/payment-methods/credit-cards cardHolderInfo.country
10308 POST v1/accounts creditCard.cardHolderInfo.phone
10308 POST v1/payment-methods/credit-cards cardHolderInfo.phone
10309 POST v1/accounts creditCard.cardHolderInfo.email
10309 POST v1/payment-methods/credit-cards cardHolderInfo.email
10401 POST v1/accounts subscription.termType
10402 POST v1/accounts subscription.initialTerm
10403 POST v1/accounts subscription.autoRenew
10404 POST v1/accounts subscription.renewalTerm
10405 POST v1/accounts subscription.notes
10406 POST v1/accounts subscription.subscribeToRatePlans
10407 POST v1/accounts subscription.contractEffectiveDate
10408 POST v1/accounts subscription.serviceActivationDate
10409 POST v1/accounts subscription.customerAcceptanceDate
10410 POST v1/accounts subscription.termStartDate
10411 POST v1/accounts subscription.customFieldsData
10414 POST v1/accounts subscription.subscriptionNumber
15001 PUT v1/accounts/{account-key} name
15002 PUT v1/accounts/{account-key} notes
15003 PUT v1/accounts/{account-key} crmId
15004 PUT v1/accounts/{account-key} invoiceTemplateId
15005 PUT v1/accounts/{account-key} communicationProfileId
15006 PUT v1/accounts/{account-key} customFieldsData
15007 PUT v1/accounts/{account-key} billToContact
15008 PUT v1/accounts/{account-key} soldToContact
15009 PUT v1/accounts/{account-key} autoPay
15101 PUT v1/accounts/{account-key} billToContact.address1
15101 PUT v1/accounts/{account-key} soldToContact.address1
15102 PUT v1/accounts/{account-key} billToContact.address2
15102 PUT v1/accounts/{account-key} soldToContact.address2
15103 PUT v1/accounts/{account-key} billToContact.city
15103 PUT v1/accounts/{account-key} soldToContact.city
15104 PUT v1/accounts/{account-key} billToContact.country
15104 PUT v1/accounts/{account-key} soldToContact.country
15105 PUT v1/accounts/{account-key} billToContact.county
15105 PUT v1/accounts/{account-key} soldToContact.county
15106 PUT v1/accounts/{account-key} billToContact.fax
15106 PUT v1/accounts/{account-key} soldToContact.fax
15107 PUT v1/accounts/{account-key} billToContact.firstName
15107 PUT v1/accounts/{account-key} soldToContact.firstName
15108 PUT v1/accounts/{account-key} billToContact.homePhone
15108 PUT v1/accounts/{account-key} soldToContact.homePhone
15109 PUT v1/accounts/{account-key} billToContact.lastName
15109 PUT v1/accounts/{account-key} soldToContact.lastName
15110 PUT v1/accounts/{account-key} billToContact.mobilePhone
15110 PUT v1/accounts/{account-key} soldToContact.mobilePhone
15111 PUT v1/accounts/{account-key} billToContact.nickname
15111 PUT v1/accounts/{account-key} soldToContact.nickname
15112 PUT v1/accounts/{account-key} billToContact.otherPhone
15112 PUT v1/accounts/{account-key} soldToContact.otherPhone
15113 PUT v1/accounts/{account-key} billToContact.otherPhoneType
15113 PUT v1/accounts/{account-key} soldToContact.otherPhoneType
15114 PUT v1/accounts/{account-key} billToContact.personalEmail
15114 PUT v1/accounts/{account-key} soldToContact.personalEmail
15115 PUT v1/accounts/{account-key} billToContact.zipCode
15115 PUT v1/accounts/{account-key} soldToContact.zipCode
15116 PUT v1/accounts/{account-key} billToContact.state
15116 PUT v1/accounts/{account-key} soldToContact.state
15117 PUT v1/accounts/{account-key} billToContact.taxRegion
15117 PUT v1/accounts/{account-key} soldToContact.taxRegion
15118 PUT v1/accounts/{account-key} billToContact.workEmail
15118 PUT v1/accounts/{account-key} soldToContact.workEmail
15119 PUT v1/accounts/{account-key} billToContact.workPhone
15119 PUT v1/accounts/{account-key} soldToContact.workPhone

200-Object Code Range

Code Request Resource Field
20001 POST v1/payment-methods/credit-cards accountKey
20002 POST v1/payment-methods/credit-cards creditCardType
20003 POST v1/payment-methods/credit-cards creditCardNumber
20004 POST v1/payment-methods/credit-cards expirationMonth
20005 POST v1/payment-methods/credit-cards expirationYear
20006 POST v1/payment-methods/credit-cards securityCode
20007 POST v1/payment-methods/credit-cards defaultPaymentMethod
20008 POST v1/payment-methods/credit-cards cardHolderInfo
25001 PUT v1/payment-methods/credit-cards/{pmt-method-id} expirationMonth
25002 PUT v1/payment-methods/credit-cards/{pmt-method-id} expirationYear
25003 PUT v1/payment-methods/credit-cards/{pmt-method-id} defaultPaymentMethod
25004 PUT v1/payment-methods/credit-cards/{pmt-method-id} cardHolderName
25005 PUT v1/payment-methods/credit-cards/{pmt-method-id} addressLine1
25006 PUT v1/payment-methods/credit-cards/{pmt-method-id} addressLine2
25007 PUT v1/payment-methods/credit-cards/{pmt-method-id} city
25008 PUT v1/payment-methods/credit-cards/{pmt-method-id} state
25009 PUT v1/payment-methods/credit-cards/{pmt-method-id} zipCode
25010 PUT v1/payment-methods/credit-cards/{pmt-method-id} country
25011 PUT v1/payment-methods/credit-cards/{pmt-method-id} securityCode
25012 PUT v1/payment-methods/credit-cards/{pmt-method-id} phone
25013 PUT v1/payment-methods/credit-cards/{pmt-method-id} email

300-Object Code Range

Code Request Resource Field
30001 POST v1/subscriptions accountKey
30002 POST v1/subscriptions termType
30003 POST v1/subscriptions initialTerm
30004 POST v1/subscriptions autoRenew
30005 POST v1/subscriptions renewalTerm
30006 POST v1/subscriptions notes
30007 POST v1/subscriptions subscribeToRatePlans
30008 POST v1/subscriptions contractEffectiveDate
30011 POST v1/subscriptions serviceActivationDate
30012 POST v1/subscriptions customerAcceptanceDate
30013 POST v1/subscriptions termStartDate
30014 POST v1/subscriptions customFieldsData
30015 POST v1/subscriptions invoiceOwnerAccountKey
30016 POST v1/subscriptions renewalSetting
30017 POST v1/subscriptions initialTermPeriodType
30018 POST v1/subscriptions renewalTermPeriodType
30101 POST v1/accounts subscription.subscribeToRatePlans.productRatePlanId
30101 POST v1/subscriptions subscribeToRatePlans.productRatePlanId
30101 POST v1/subscriptions/preview subscribeToRatePlans.productRatePlanId
30102 POST v1/accounts subscription.subscribeToRatePlans.chargeOverrides
30102 POST v1/subscriptions subscribeToRatePlans.chargeOverrides
30102 POST v1/subscriptions/preview subscribeToRatePlans.chargeOverrides
30201 POST v1/accounts subscription.subscribeToRatePlans.chargeOverrides.productRatePlanChargeId
30201 POST v1/subscriptions subscribeToRatePlans.chargeOverrides.productRatePlanChargeId
30201 POST v1/subscriptions/preview subscribeToRatePlans.chargeOverrides.productRatePlanChargeId
30202 POST v1/accounts subscription.subscribeToRatePlans.chargeOverrides.quantity
30202 POST v1/subscriptions subscribeToRatePlans.chargeOverrides.quantity
30202 POST v1/subscriptions/preview subscribeToRatePlans.chargeOverrides.quantity
30204 POST v1/subscriptions subscribeToRatePlans.chargeOverrides.number
30204 POST v1/subscriptions/preview subscribeToRatePlans.chargeOverrides.number
30205 POST v1/subscriptions subscribeToRatePlans.chargeOverrides.description
30205 POST v1/subscriptions/preview subscribeToRatePlans.chargeOverrides.description
30206 POST v1/subscriptions subscribeToRatePlans.chargeOverrides.price
30206 POST v1/subscriptions/preview subscribeToRatePlans.chargeOverrides.price
30207 POST v1/subscriptions subscribeToRatePlans.chargeOverrides.includedUnits
30207 POST v1/subscriptions/preview subscribeToRatePlans.chargeOverrides.includedUnits
30208 POST v1/subscriptions subscribeToRatePlans.chargeOverrides.overagePrice
30208 POST v1/subscriptions/preview subscribeToRatePlans.chargeOverrides.overagePrice
30209 POST v1/subscriptions subscribeToRatePlans.chargeOverrides.listPriceBase
30209 POST v1/subscriptions/preview subscribeToRatePlans.chargeOverrides.listPriceBase
30210 POST v1/subscriptions subscribeToRatePlans.chargeOverrides.discountAmount
30210 POST v1/subscriptions/preview subscribeToRatePlans.chargeOverrides.discountAmount
30211 POST v1/subscriptions subscribeToRatePlans.chargeOverrides.discountPercentage
30211 POST v1/subscriptions/preview subscribeToRatePlans.chargeOverrides.discountPercentage
30212 POST v1/subscriptions subscribeToRatePlans.chargeOverrides.applyDiscountTo
30212 POST v1/subscriptions/preview subscribeToRatePlans.chargeOverrides.applyDiscountTo
30213 POST v1/subscriptions subscribeToRatePlans.chargeOverrides.discountLevel
30213 POST v1/subscriptions/preview subscribeToRatePlans.chargeOverrides.discountLevel
30214 POST v1/subscriptions subscribeToRatePlans.chargeOverrides.triggerEvent
30214 POST v1/subscriptions/preview subscribeToRatePlans.chargeOverrides.triggerEvent
30215 POST v1/subscriptions subscribeToRatePlans.chargeOverrides.triggerDate
30215 POST v1/subscriptions/preview subscribeToRatePlans.chargeOverrides.triggerDate
30216 POST v1/subscriptions subscribeToRatePlans.chargeOverrides.billingPeriod
30216 POST v1/subscriptions/preview subscribeToRatePlans.chargeOverrides.billingPeriod
30217 POST v1/subscriptions subscribeToRatePlans.chargeOverrides.specificBillingPeriod
30217 POST v1/subscriptions/preview subscribeToRatePlans.chargeOverrides.specificBillingPeriod
30218 POST v1/subscriptions subscribeToRatePlans.chargeOverrides.billingPeriodAlignment
30218 POST v1/subscriptions/preview subscribeToRatePlans.chargeOverrides.billingPeriodAlignment
30219 POST v1/subscriptions subscribeToRatePlans.chargeOverrides.billingTiming
30219 POST v1/subscriptions/preview subscribeToRatePlans.chargeOverrides.billingTiming
30220 POST v1/subscriptions subscribeToRatePlans.chargeOverrides.billCycleType
30220 POST v1/subscriptions/preview subscribeToRatePlans.chargeOverrides.billCycleType
30221 POST v1/subscriptions subscribeToRatePlans.chargeOverrides.billCycleDay
30221 POST v1/subscriptions/preview subscribeToRatePlans.chargeOverrides.billCycleDay
30222 POST v1/subscriptions subscribeToRatePlans.chargeOverrides.numberOfPeriods
30222 POST v1/subscriptions/preview subscribeToRatePlans.chargeOverrides.numberOfPeriods
30223 POST v1/subscriptions subscribeToRatePlans.chargeOverrides.overageUnusedUnitsCreditOption
30223 POST v1/subscriptions/preview subscribeToRatePlans.chargeOverrides.overageUnusedUnitsCreditOption
30224 POST v1/subscriptions subscribeToRatePlans.chargeOverrides.unusedUnitsCreditRates
30224 POST v1/subscriptions/preview subscribeToRatePlans.chargeOverrides.unusedUnitsCreditRates
30225 POST v1/subscriptions subscribeToRatePlans.chargeOverrides.priceChangeOption
30225 POST v1/subscriptions/preview subscribeToRatePlans.chargeOverrides.priceChangeOption
30226 POST v1/subscriptions subscribeToRatePlans.chargeOverrides.priceIncreasePercentage
30226 POST v1/subscriptions/preview subscribeToRatePlans.chargeOverrides.priceIncreasePercentage
30227 POST v1/subscriptions subscribeToRatePlans.chargeOverrides.tiers
30227 POST v1/subscriptions/preview subscribeToRatePlans.chargeOverrides.tiers
30228 POST v1/subscriptions subscribeToRatePlans.chargeOverrides.endDateCondition
30228 POST v1/subscriptions/preview subscribeToRatePlans.chargeOverrides.endDateCondition
30229 POST v1/subscriptions subscribeToRatePlans.chargeOverrides.upToPeriodsType
30229 POST v1/subscriptions/preview subscribeToRatePlans.chargeOverrides.upToPeriodsType
30230 POST v1/subscriptions subscribeToRatePlans.chargeOverrides.upToPeriods
30230 POST v1/subscriptions/preview subscribeToRatePlans.chargeOverrides.upToPeriods
30231 POST v1/subscriptions subscribeToRatePlans.chargeOverrides.specificEndDate
30231 POST v1/subscriptions/preview subscribeToRatePlans.chargeOverrides.specificEndDate
30232 POST v1/subscriptions subscribeToRatePlans.chargeOverrides.weeklyBillCycleDay
30232 POST v1/subscriptions/preview subscribeToRatePlans.chargeOverrides.weeklyBillCycleDay
30301 POST v1/subscriptions subscribeToRatePlans.chargeOverrides.tiers.tier
30301 POST v1/subscriptions/preview  subscribeToRatePlans.chargeOverrides.tiers.tier
30302 POST v1/subscriptions subscribeToRatePlans.chargeOverrides.tiers.startingUnit
30302 POST v1/subscriptions/preview subscribeToRatePlans.chargeOverrides.tiers.startingUnit
30303 POST v1/subscriptions subscribeToRatePlans.chargeOverrides.tiers.endingUnit
30303 POST v1/subscriptions/preview subscribeToRatePlans.chargeOverrides.tiers.endingUnit
30304 POST v1/subscriptions subscribeToRatePlans.chargeOverrides.tiers.price
30304 POST v1/subscriptions/preview subscribeToRatePlans.chargeOverrides.tiers.price
30305 POST v1/subscriptions subscribeToRatePlans.chargeOverrides.tiers.priceFormat
30305 POST v1/subscriptions/preview subscribeToRatePlans.chargeOverrides.tiers.priceFormat
31001 POST v1/subscriptions/preview accountKey
31002 POST v1/subscriptions/preview previewAccountInfo
31003 POST v1/subscriptions/preview termType
31004 POST v1/subscriptions/preview initialTerm
31005 POST v1/subscriptions/preview subscribeToRatePlans
31006 POST v1/subscriptions/preview contractEffectiveDate
31007 POST v1/subscriptions/preview invoiceTargetDate
31008 POST v1/subscriptions/preview serviceActivationDate
31009 POST v1/subscriptions/preview customerAcceptanceDate
31010 POST v1/subscriptions/preview termStartDate
31013 POST v1/subscriptions/preview includeExistingDraftInvoiceItems
31101 POST v1/subscriptions/preview previewAccountInfo.currency
31102 POST v1/subscriptions/preview previewAccountInfo.billCycleDay
31103 POST v1/subscriptions/preview previewAccountInfo.billToContact
31201 POST v1/subscriptions/preview previewAccountInfo.billToContact.country
31202 POST v1/subscriptions/preview previewAccountInfo.billToContact.state
31203 POST v1/subscriptions/preview previewAccountInfo.billToContact.city
31204 POST v1/subscriptions/preview previewAccountInfo.billToContact.county
31205 POST v1/subscriptions/preview previewAccountInfo.billToContact.taxRegion
31206 POST v1/subscriptions/preview previewAccountInfo.billToContact.zipCode
32001 PUT v1/subscriptions/{subscription-key}/cancel cancellationPolicy

32002

PUT

v1/subscriptions/{subscription-key}/cancel

cancellationEffectiveDate

32101

PUT

v1/subscriptions/{subscription-key}/suspend

suspendPolicy

32102

PUT

v1/subscriptions/{subscription-key}/suspend

suspendPeriods

32103

PUT

v1/subscriptions/{subscription-key}/suspend

suspendPeriodsType

32104

PUT

v1/subscriptions/{subscription-key}/suspend

suspendSpecificDate

32105

PUT

v1/subscriptions/{subscription-key}/suspend

resume

32106

PUT

v1/subscriptions/{subscription-key}/suspend

resumePolicy

32107

PUT

v1/subscriptions/{subscription-key}/suspend

resumePeriods

32108

PUT

v1/subscriptions/{subscription-key}/suspend

resumePeriodsType

32109

PUT

v1/subscriptions/{subscription-key}/suspend

resumeSpecificDate

32110

PUT

v1/subscriptions/{subscription-key}/suspend

extendsTerm

32111

PUT

v1/subscriptions/{subscription-key}/suspend

contractEffectiveDate

32113

PUT

v1/subscriptions/{subscription-key}/suspend

invoiceTargetDate

32114

PUT

v1/subscriptions/{subscription-key}/suspend

invoice

32115

PUT

v1/subscriptions/{subscription-key}/suspend

collect

32116

PUT

v1/subscriptions/{subscription-key}/suspend

applyCreditBalance

32201

PUT

v1/subscriptions/{subscription-key}/resume

resumePolicy

32202

PUT

v1/subscriptions/{subscription-key}/resume

resumePeriods

32203

PUT

v1/subscriptions/{subscription-key}/resume

resumePeriodsType

32204

PUT

v1/subscriptions/{subscription-key}/resume

resumeSpecificDate

32205

PUT

v1/subscriptions/{subscription-key}/resume

extendsTerm

32206

PUT

v1/subscriptions/{subscription-key}/resume

contractEffectiveDate

32208

PUT

v1/subscriptions/{subscription-key}/resume

invoiceTargetDate

32209

PUT

v1/subscriptions/{subscription-key}/resume

invoice

32210

PUT

v1/subscriptions/{subscription-key}/resume

collect

32211

PUT

v1/subscriptions/{subscription-key}/resume

applyCreditBalance

35001 PUT v1/subscriptions/{subscription-key} termType
35002 PUT v1/subscriptions/{subscription-key} currentTerm
35003 PUT v1/subscriptions/{subscription-key} renewalTerm
35004 PUT v1/subscriptions/{subscription-key} autoRenew
35005 PUT v1/subscriptions/{subscription-key} notes
35006 PUT v1/subscriptions/{subscription-key} add
35007 PUT v1/subscriptions/{subscription-key} update
35008 PUT v1/subscriptions/{subscription-key} remove
35009 PUT v1/subscriptions/{subscription-key} preview
35012 PUT v1/subscriptions/{subscription-key} customFieldsData
35014 PUT v1/subscriptions/{subscription-key} includeExistingDraftInvoiceItems
35101 PUT v1/subscriptions/{subscription-key} add.chargeOverrides.productRatePlanChargeId
35102 PUT v1/subscriptions/{subscription-key} add.chargeOverrides.quantity
<35201> PUT v1/subscriptions/{subscription-key} update.chargeUpdateDetails.ratePlanChargeId
35202 PUT v1/subscriptions/{subscription-key} update.chargeUpdateDetails.quantity
35301 PUT v1/subscriptions/{subscription-key} add.productRatePlanId
35302 PUT v1/subscriptions/{subscription-key} add.chargeOverrides
35303 PUT v1/subscriptions/{subscription-key} add.contractEffectiveDate
35305 PUT v1/subscriptions/{subscription-key} add.serviceActivationDate
35306 PUT v1/subscriptions/{subscription-key} add.customerAcceptanceDate
35401 PUT v1/subscriptions/{subscription-key} update.ratePlanId
35402 PUT v1/subscriptions/{subscription-key} update.chargeUpdateDetails
35403 PUT v1/subscriptions/{subscription-key} update.contractEffectiveDate
35406 PUT v1/subscriptions/{subscription-key} update.serviceActivationDate
35407 PUT v1/subscriptions/{subscription-key} update.customerAcceptanceDate
35501 PUT v1/subscriptions/{subscription-key} remove.ratePlanId
35502 PUT v1/subscriptions/{subscription-key} remove.contractEffectiveDate
35503 PUT v1/subscriptions/{subscription-key} remove.serviceActivationDate
35504 PUT v1/subscriptions/{subscription-key} remove.customerAcceptanceDate

400-Object Code Range

Code Request Resource Field
40101 POST v1/accounts invoiceCollect
40101 POST v1/subscriptions invoiceCollect
40101 PUT v1/subscriptions/{subscription-key} invoiceCollect
40101 PUT v1/subscriptions/{subscription-key}/renew invoiceCollect
40101 PUT v1/subscriptions/{subscription-key}/cancel invoiceCollect
40201 POST v1/accounts invoiceTargetDate
40201 POST v1/subscriptions invoiceTargetDate
40201 POST v1/subscriptions/preview invoiceTargetDate
40201 PUT v1/subscriptions/{subscription-key} invoiceTargetDate
40201 PUT v1/subscriptions/{subscription-key}/renew invoiceTargetDate
40201 PUT v1/subscriptions/{subscription-key}/cancel invoiceTargetDate

500-Object Code Range

Code Request Resource Field
54101 PUT v1/revenue-schedules/{rs-number}/distribute-revenue-across-accounting-periods revenueDistributions.accountingPeriodName
54102 PUT v1/revenue-schedules/{rs-number}/distribute-revenue-across-accounting-periods revenueDistributions.newAmount
54201 PUT v1/revenue-schedules/{rs-number}/distribute-revenue-with-date-range recognitionStart
54202 PUT v1/revenue-schedules/{rs-number}/distribute-revenue-with-date-range recognitionEnd
54203 PUT v1/revenue-schedules/{rs-number}/distribute-revenue-with-date-range eventType
54204 PUT v1/revenue-schedules/{rs-number}/distribute-revenue-with-date-range notes
54205 PUT v1/revenue-schedules/{rs-number}/distribute-revenue-with-date-range eventTypeSystemId
54206 PUT v1/revenue-schedules/{rs-number}/distribute-revenue-with-date-range customFieldsValues
54207 PUT v1/revenue-schedules/{rs-number}/distribute-revenue-with-date-range distributionType
54301 PUT /v1/revenue-schedules/{rs-number}/basic-information notes
54302 PUT v1/revenue-schedules/{rs-number}/basic-information referenceId
54303 PUT v1/revenue-schedules/{rs-number}/basic-information customFieldsValues
54601 PUT v1/revenue-schedules/{rs-number}/distribute-revenue-across-accounting-periods eventType
54602 PUT v1/revenue-schedules/{rs-number}/distribute-revenue-across-accounting-periods revenueDistributions
54603 PUT v1/revenue-schedules/{rs-number}/distribute-revenue-across-accounting-periods eventTypeSystemId
54604 PUT v1/revenue-schedules/{rs-number}/distribute-revenue-across-accounting-periods notes
54605 PUT v1/revenue-schedules/{rs-number}/distribute-revenue-across-accounting-periods customFieldsValues
56001 POST v1/revenue-schedules/subscription-charges/{charge-key} referenceId
56002 POST v1/revenue-schedules/subscription-charges/{charge-key} amount
56003 POST v1/revenue-schedules/subscription-charges/{charge-key} notes
56004 POST v1/revenue-schedules/subscription-charges/{charge-key} revenueDistributions
56005 POST v1/revenue-schedules/subscription-charges/{charge-key} revenueEvent
56006 POST v1/revenue-schedules/subscription-charges/{charge-key} customFieldsValues
56007 POST v1/revenue-schedules/subscription-charges/{charge-key} revenueScheduleDate
56008 POST v1/revenue-schedules/subscription-charges/{charge-key} overrideChargeAccountingCodes
56009 POST v1/revenue-schedules/subscription-charges/{charge-key} recognizedRevenueAccountingCodeType
56010 POST v1/revenue-schedules/subscription-charges/{charge-key}; recognizedRevenueAccountingCode
56011 POST v1/revenue-schedules/subscription-charges/{charge-key} deferredRevenueAccountingCodeType
56012 POST v1/revenue-schedules/subscription-charges/{charge-key} deferredRevenueAccountingCode
56101 POST v1/revenue-schedules/subscription-charges/{charge-key} revenueDistributions.accountingPeriodName
56102 POST v1/revenue-schedules/subscription-charges/{charge-key} revenueDistributions.newAmount
56201 POST v1/revenue-schedules/subscription-charges/{charge-key} revenueEvent.eventType
56202 POST v1/revenue-schedules/subscription-charges/{charge-key} revenueEvent.eventTypeSystemId
56203 POST v1/revenue-schedules/subscription-charges/{charge-key} revenueEvent.notes
56204 POST v1/revenue-schedules/subscription-charges/{charge-key} revenueEvent.customFieldsValues
 

 

Last modified
17:51, 12 Jun 2017

Tags

This page has no custom tags.

Classifications

(not set)