Welcome to Zuora Product Documentation

Explore our rich library of product information

Subscribe and Amend APIs

This article provides an overview of the Subscribe and Amend APIs, detailing their categories and functionalities, including REST and SOAP implementations.

The following table lists the Subscribe and Amend APIs.

Category

Subscribe and Amend APIs

REST

  • ​​​​​Preview a subscription

  • Preview a subscription by subscription key

  • Create a subscription

  • Update a subscription

  • Delete a subscription by number

  • Update subscription custom fields of a subscription version

  • List subscriptions by account key

  • Retrieve a subscription by key

  • Retrieve a subscription by key and version

  • Subscribe

  • Amend

CRUD REST

  • CRUD: Update subscription

  • CRUD: Delete subscription

  • CRUD: Update amendment

  • CRUD: Delete amendment

  • CRUD: Retrieve a subscription

  • CRUD: Retrieve an amendment

SOAP

  • subscribe()

  • amend()

  • create() : You can not use this API to create the Amendment object, you can still use this API to create other objects.

  • delete() : You can not use this API to delete the Amendment and Subscription objects, you can still use this API to delete other objects.

  • update(): You can not use this API to update the Amendment and Subscription objects, you can still use this API to update other objects.

For more information, see SOAP API Object Reference .