API Reference: Billing

Introduction Welcome to the reference for the Zuora Billing REST API! To learn about the common use cases of Zuora Billing REST APIs, check out the [API Guides](https://www.zuora.com/developer/api-guides/). In addition to Zuora API Reference; Billing, we also provide API references for other Zuora products: [API Reference: Collect](https://www.zuora.com/developer/collect-api/) [API Reference: Revenue](https://www.zuora.com/developer/revpro-api/) The Zuora REST API provides a broad set of operations and resources that: Enable Web Storefront integration from your website. Support self-service subscriber sign-ups and account management. Process revenue schedules through custom revenue rule models. Enable manipulation of most objects in the Zuora Billing Object Model. Want to share your opinion on how our API works for you? Tell us how you feel about using our API and what we can do to make it better. Access to the API If you have a Zuora tenant, you can access the Zuora REST API via one of the following endpoints: Tenant Base URL for REST Endpoints ------------------------- ------------------------- US Production https://rest.zuora.com US API Sandbox https://rest.apisandbox.zuora.com US Performance Test https://rest.pt1.zuora.com US Production Copy Submit a request at Zuora Global Support to enable the Zuora REST API in your tenant and obtain the base URL for REST endpoints. See [REST endpoint base URL of Production Copy (Service) Environment for existing and new customers](https://community.zuora.com/t5/API/REST-endpoint-base-URL-of-Production-Copy-Service-Environment/td-p/29611) for more information. US Cloud Production https://rest.na.zuora.com US Cloud API Sandbox https://rest.sandbox.na.zuora.com US Central Sandbox https://rest.test.zuora.com EU Production https://rest.eu.zuora.com EU API Sandbox https://rest.sandbox.eu.zuora.com EU Central Sandbox https://rest.test.eu.zuora.com The Production endpoint provides access to your live user data. Sandbox tenants are a good place to test code without affecting real-world data. If you would like Zuora to provision a Sandbox tenant for you, contact your Zuora representative for assistance. If you do not have a Zuora tenant, go to https://www.zuora.com/resource/zuora-test-drive and sign up for a Production Test Drive tenant. The tenant comes with seed data, including a sample product catalog. API Changelog You can find the Changelog of the API Reference: Billing in the Zuora Community. Authentication OAuth v2.0 Zuora recommends that you use OAuth v2.0 to authenticate to the Zuora REST API. Currently, OAuth is not available in every environment. See [Zuora Testing Environments](https://knowledgecenter.zuora.com/BB Introducing Z Business/D Zuora Environments) for more information. Zuora recommends you to create a dedicated API user with API write access on a tenant when authenticating via OAuth, and then create an OAuth client for this user. See Create an API User for how to do this. By creating a dedicated API user, you can control permissions of the API user without affecting other non-API users. If a user is deactivated, all of the user's OAuth clients will be automatically deactivated. Authenticating via OAuth requires the following steps: 1. Create a Client 2. Generate a Token 3. Make Authenticated Requests Create a Client You must first [create an OAuth client](https://knowledgecenter.zuora.com/CF Users and Administrators/A Administrator Settings/Manage Users Create an OAuth Client for a User) in the Zuora UI. To do this, you must be an administrator of your Zuora tenant. This is a one-time operation. You will be provided with a Client ID and a Client Secret. Please note this information down, as it will be required for the next step. Note: The OAuth client will be owned by a Zuora user account. If you want to perform PUT, POST, or DELETE operations using the OAuth client, the owner of the OAuth client must have a Platform role that includes the "API Write Access" permission. Ge…