Resources
The table below shows how the primary API resources or objects in Product Catalog 1.0 map to those in Product Catalog 2.0. Some resources in the latter are newly introduced and have no equivalents in the former.
Product Catalog 1.0 |
Product Catalog 2.0 |
N/A |
|
N/A |
|
N/A |
Endpoints
Each of the tables in this section maps the various endpoints in Product Catalog 1.0 to their corresponding equivalents in Product Catalog 2.0.
Note
This section does not list the endpoints that have no change from Product Catalog 1.0 to 2.0.
Plans
Product Catalog 1.0 |
Product Catalog 2.0 |
|
|
|
|
|
|
|
|
Addons
Product Catalog 1.0 |
Product Catalog 2.0 |
|
|
|
|
|
|
|
|
Coupons
Product Catalog 1.0 |
Product Catalog 2.0 |
|
|
|
|
Subscriptions
Product Catalog 1.0 |
Product Catalog 2.0 |
|
|
|
|
|
|
|
|
|
|
Invoices
Product Catalog 1.0 |
Product Catalog 2.0 |
|
|
|
|
|
|
|
|
Quotes
Product Catalog 1.0 |
Product Catalog 2.0 |
|
|
|
|
|
|
|
|
|
|
|
|
Gifts
Product Catalog 1.0 |
Product Catalog 2.0 |
|
|
Hosted Pages
Product Catalog 1.0 |
Product Catalog 2.0 |
|
|
|
|
|
|
|
|
Estimates
Product Catalog 1.0 |
Product Catalog 2.0 |
|
|
|
|
|
|
|
|
|
|
|
|
Parameters
The tables in this section map the individual input parameters for endpoints from Product Catalog 1.0 to their Product Catalog 2.0 equivalents.
Plans
Create a plan
Product Catalog 1.0 |
Product Catalog 2.0 |
Create a plan
|
Create an item
|
|
|
|
|
|
|
|
Not passed as input for this endpoint. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
N/A |
|
|
|
|
Create an item price
|
N/A |
|
N/A |
|
N/A |
|
|
|
|
|
|
|
|
|
|
|
|
N/A |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Addons
Create an addon
Product Catalog 1.0 |
Product Catalog 2.0 |
|
Create an item
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Not passed as input for this endpoint. |
|
Create an item price
|
N/A |
|
N/A |
|
N/A |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Attached Addons
Product Catalog 1.0 |
Product Catalog 2.0 |
Create a plan
A single call to this API can be used to attach all the required recurring and non-recurring addons to the plan. |
Each call to this API attaches a single item (addon or charge) to the plan. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Subscriptions
Create subscription for a customer
Product Catalog 1.0 |
Product Catalog 2.0 |
Create subscription for a customer
|
Create a subscription for items
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
N/A |
|
N/A |
|
N/A |
|
N/A |
|
Update a subscription
Product Catalog 1.0 |
Product Catalog 2.0 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
N/A |
|
N/A |
|
N/A |
|
N/A |
|
Cancel a subscription
Product Catalog 1.0 |
Product Catalog 2.0 |
|
|
|
|
|
|
|
|
|
|
Invoices
Create an Invoice
Product Catalog 1.0 |
Product Catalog 2.0 |
|
|
|
|
|
|
|
|
|
|
|
|
N/A |
|
N/A |
|
N/A |
|
N/A |
|
Create invoice for addon
Product Catalog 1.0 |
Product Catalog 2.0 |
|
|
|
|
|
|
|
|
|
|
|
|
N/A |
|
N/A |
|
N/A |
|
Add addon item to a pending invoice
Product Catalog 1.0 |
Product Catalog 2.0 |
|
|
|
|
|
|
|
|
|
|
|
|
N/A |
|
N/A |
|
N/A |
|
Coupons
Create a coupon
Product Catalog 1.0 |
Product Catalog 2.0 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
N/A |
|
N/A |
|
N/A |
|
N/A |
|
Update a coupon
Product Catalog 1.0 |
Product Catalog 2.0 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
N/A |
|
N/A |
|
N/A |
|
N/A |
|
Hosted Pages
Checkout a new subscription
Product Catalog 1.0 |
Product Catalog 2.0 |
|
|
|
|
|
|
|
|
|
N/A |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
N/A |
|
N/A |
|
N/A |
|
N/A |
|
Checkout existing subscription
Product Catalog 1.0 |
Product Catalog 2.0 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
N/A |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
N/A |
|
N/A |
|
N/A |
|
N/A |
|
Estimates
Estimate creating a subscription
Product Catalog 1.0 |
Product Catalog 2.0 |
|
|
|
|
|
|
|
|
|
N/A |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
N/A |
|
N/A |
|
N/A |
|
N/A |
|
Estimate updating a subscription
Product Catalog 1.0 |
Product Catalog 2.0 |
|
|
|
|
|
|
|
|
|
|
|
N/A |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
N/A |
|
N/A |
|
N/A |
|
N/A |
|
Create invoice estimate
Product Catalog 1.0 |
Product Catalog 2.0 |
|
|
|
|
|
|
|
|
|
|
|
|
N/A |
|
N/A |
|
N/A |
|
N/A |
|