How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Zuora

Zuora Subscriptions API

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.

Documentation Provider Profile APIs.io OpenAPI GitHub

Zuora Subscriptions API is one of 80 APIs that Zuora publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Subscription. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 12 operations across 11 paths, and defines 56 schemas. It is described by OpenAPI 3.2.0, at version 2023-12-15.

Requests are made against a single base URL, https://rest.zuora.com/.

12 operations 11 paths 56 schemas 3 GET2 POST7 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2023-12-15
Server
https://rest.zuora.com/
Contact
docs@zuora.com
Resource Areas
1

Paths & Operations 12

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…

POST
/v1/subscriptions/preview
Preview a subscription
POST_PreviewSubscription 8 params body → 200
POST
/v1/subscriptions
Create a subscription
POST_Subscription 8 params body → 200
GET
/v1/subscriptions/accounts/{account-key}
List subscriptions by account key
GET_SubscriptionsByAccount 11 params → 200
PUT
/v1/subscriptions/{subscription-key}
Update a subscription
PUT_Subscription 8 params body → 200
GET
/v1/subscriptions/{subscription-key}
Retrieve a subscription by key
GET_SubscriptionsByKey 9 params → 200
GET
/v1/subscriptions/{subscription-key}/versions/{version}
Retrieve a subscription by key and version
GET_SubscriptionsByKeyAndVersion 10 params → 200
PUT
/v1/subscriptions/{subscription-key}/renew
Renew a subscription
PUT_RenewSubscription 8 params body → 200
PUT
/v1/subscriptions/{subscription-key}/cancel
Cancel a subscription
PUT_CancelSubscription 8 params body → 200
PUT
/v1/subscriptions/{subscription-key}/resume
Resume a subscription
PUT_ResumeSubscription 8 params body → 200
PUT
/v1/subscriptions/{subscription-key}/suspend
Suspend a subscription
PUT_SuspendSubscription 8 params body → 200
PUT
/v1/subscriptions/{subscription-key}/delete
Delete a subscription by number
PUT_DeleteSubscription 7 params → 200
PUT
/v1/subscriptions/{subscriptionNumber}/versions/{version}/customFields
Update subscription custom fields of a subscription version
PUT_UpdateSubscriptionCustomFieldsOfASpecifiedVersion 8 params body → 200

Schemas 56

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.

SubscriptionObjectCustomFields
object
Container for custom fields of a Subscription object.
POSTSubscriptionPreviewResponseType
object
13 properties
PUTSubscriptionSuspendType
object
24 properties 1 required
AccountObjectNSFields
object
Container for Account fields provided by the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
9 properties
PUTSubscriptionResumeType
object
19 properties 1 required
POSTSubscriptionPreviewType
ContactObjectCustomFields
object
Container for custom fields of a Contact object.
GETIntervalPriceTierType
object
6 properties
PUTSubscriptionPatchSpecificVersionRequestType
object
2 properties
GETSubscriptionType
SubscriptionObjectQTFields
object
Container for Subscription fields provided by Zuora Quotes.
6 properties
PUTSubscriptionResponseType
object
17 properties
PUTSrpChangeType
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…
RatePlanObjectCustomFields
object
Container for custom fields of a Rate Plan object.
GETSubscriptionTypeWithSuccess
PUTDeleteSubscriptionResponseType
object
1 property
PUTSrpUpdateType
POSTSubscriptionCancellationType
object
16 properties 1 required
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
PUTSrpAddType
PUTSrpRemoveType
object
9 properties 1 required
PUTSubscriptionResumeResponseType
object
9 properties
GETIntervalPriceType
object
5 properties
PUTSubscriptionType
GETSubscriptionRatePlanType
POSTSubscriptionCancellationResponseType
object
9 properties
POSTSubscriptionPreviewInvoiceItemsType
object
11 properties
POSTSubscriptionResponseType
object
9 properties
SubscriptionObjectNSFields
object
Container for Subscription fields provided by the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).
5 properties
POSTSrpCreateType
POSTTierType
object
5 properties 2 required
PUTRenewSubscriptionType
object
12 properties
CommonResponseType
object
3 properties
GETDiscountApplyDetailsType
object
5 properties
POSTSubscriptionPreviewCreditMemoItemsType
object
12 properties
GETSubscriptionProductFeatureType
object
4 properties
RatePlanChargeObjectCustomFields
object
Container for custom fields of a Rate Plan Charge object.
PUTScAddType
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
POSTSubscriptionPreviewTaxationItemsType
object
11 properties
PUTSubscriptionPreviewInvoiceItemsType
object
10 properties
POSTSubscriptionType
GETSubscriptionWrapper
object
3 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…
GETSubscriptionOfferType
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…
PUTScUpdateType
PUTRenewSubscriptionResponseType
object
9 properties
GETSubscriptionStatusHistoryType
AccountObjectCustomFields
object
Container for custom fields of an Account object.
POSTScCreateType
PUTSubscriptionSuspendResponseType
object
10 properties
GETSubscriptionRatePlanChargesType
SubscriptionOfferObjectCustomFields
object
Container for custom fields of a Subscription Offer object.
GETTierType
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zuora-subscriptions-api-openapi.yml Raw ↑

Other APIs Zuora publishes across the network.

Zuora V1 API
AE Profile APIs.io
Zuora Accounting Codes API
AE Profile APIs.io
Zuora Accounting Periods API
AE Profile APIs.io
Zuora Accounts API
AE Profile APIs.io
Zuora Actions API
AE Profile APIs.io
Zuora Aggregate Queries API
AE Profile APIs.io
Zuora API Health API
AE Profile APIs.io
Zuora Attachments API
AE Profile APIs.io
Zuora Bill Run API
AE Profile APIs.io
Zuora Bill Run Health API
AE Profile APIs.io
Zuora Billing Documents API
AE Profile APIs.io
Zuora Billing Preview Run API
AE Profile APIs.io
#Subscription
← Back to Z APIs
API Details
ID
zuora:zuora-subscriptions-api
Server
https://rest.zuora.com/
Docs
https://developer.zuora.com/v1-api-reference/introduction
Provider
Zuora
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=zuora-subscriptions-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/zuora-subscriptions-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Zuora Subscriptions API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.