A subscription is a product or service that has recurring charges, such as a monthly flat fee or charges based on usage. Subscriptions can also include one-time charges, such as activation fees. Every subscription must be associated with an account. At least one active account must exist before any subscriptions can be created.For more information, see Subscriptions.
Across 11 paths, the API surfaces 12 operations — 3 GET, 2 POST, 7 PUT. Each is listed below with its method, path, parameters, and response codes.
Subscriptions 12
A subscription is a product or service that has recurring charges, such as a monthly flat fee or charges based on usage. Subscriptions can also include one-time charges, such as a…
The contract defines 56 schemas that model the data the API accepts and returns. The most detailed are PUTSubscriptionSuspendType (24 properties), PUTSubscriptionResumeType (19 properties), PUTSubscriptionResponseType (17 properties), POSTSubscriptionCancellationType (16 properties). Each schema is shown below with its type and property counts.
PUTSrpAddType
PUTSrpChangeType
SubscriptionOfferObjectCustomFields
object
Container for custom fields of a Subscription Offer object.
POSTSubscriptionPreviewResponseType
object
13 properties
PUTSubscriptionResumeType
object
19 properties1 required
GETIntervalPriceType
object
5 properties
POSTScCreateType
GETIntervalPriceTierType
object
6 properties
AccountObjectCustomFields
object
Container for custom fields of an Account object.
SubscriptionObjectQTFields
object
Container for Subscription fields provided by Zuora Quotes.
6 properties
AccountObjectNSFields
object
Container for Account fields provided by the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
9 properties
CommonResponseType
object
3 properties
PUTSubscriptionPreviewInvoiceItemsType
object
10 properties
GETSubscriptionRatePlanChargesType
ChargeModelConfigurationType
object
Container for charge model configuration data. Note: This field is only available if you have the High Water Mark, Pre-Rated Pricing, or Multi-Attribute Pricin…
3 properties
GETDeliveryScheduleType
object
The deliverySchedule is used for the Delivery Pricing charge model only. Note: The Delivery Pricing charge model is in the Early Adopter phase. We are actively…
8 properties
PUTScUpdateType
GETSubscriptionOfferType
SubscriptionObjectNSFields
object
Container for Subscription fields provided by the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
5 properties
GETAccountSummaryTypeSoldToContact
Container for sold-to contact information. Note: - If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body…
GETSubscriptionRatePlanType
GETSubscriptionTypeWithSuccess
ContactObjectCustomFields
object
Container for custom fields of a Contact object.
POSTSubscriptionPreviewTypePreviewAccountInfo
A container for providing a customer account information if you do not have an existing customer account. This customer account information is only used for su…
GETSubscriptionStatusHistoryType
GETSubscriptionProductFeatureType
object
4 properties
PUTSrpRemoveType
object
9 properties1 required
PUTScAddType
POSTSubscriptionResponseType
object
9 properties
GETTierType
object
5 properties
POSTSubscriptionPreviewCreditMemoItemsType
object
12 properties
PUTSrpUpdateType
GETSubscriptionWrapper
object
3 properties
POSTSubscriptionPreviewType
POSTSubscriptionPreviewInvoiceItemsType
object
11 properties
POSTTierType
object
5 properties2 required
PUTSubscriptionResumeResponseType
object
9 properties
PUTSubscriptionSuspendType
object
24 properties1 required
PUTSubscriptionSuspendResponseType
object
10 properties
PUTSubscriptionPatchSpecificVersionRequestType
object
2 properties
POSTSubscriptionType
SubscriptionObjectCustomFields
object
Container for custom fields of a Subscription object.
PUTRenewSubscriptionResponseType
object
9 properties
PUTDeleteSubscriptionResponseType
object
1 property
GETDiscountApplyDetailsType
object
5 properties
GETAccountSummaryTypeBillToContact
Container for bill-to contact information. Note: - If you have the Flexible Billing Attributes feature disabled, this field is unavailable in the request body…
PUTSubscriptionResponseType
object
17 properties
PUTSubscriptionType
GETSubscriptionType
POSTSubscriptionCancellationResponseType
object
9 properties
RatePlanChargeObjectCustomFields
object
Container for custom fields of a Rate Plan Charge object.
PUTRenewSubscriptionType
object
12 properties
RatePlanObjectCustomFields
object
Container for custom fields of a Rate Plan object.
POSTSubscriptionPreviewTaxationItemsType
object
11 properties
POSTSrpCreateType
POSTSubscriptionCancellationType
object
16 properties1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
