Public preview
Supported endpoints Public preview
Browse the API endpoints available for batch processing.
The Batch Jobs API supports the following endpoints. Each batch job targets a single endpoint, and all requests in the batch go to that endpoint.
Accounts
| Endpoint | Path |
|---|---|
| Update an account | POST /v1/accounts/:id |
| Create an account | POST /v1/accounts |
Coupons
| Endpoint | Path |
|---|---|
| Create a coupon | POST /v1/coupons |
| Update a coupon | POST /v1/coupons/:coupon |
| Delete a coupon | DELETE /v1/coupons/:coupon |
Credit Notes
| Endpoint | Path |
|---|---|
| Create a credit note | POST /v1/credit_notes |
Customers
| Endpoint | Path |
|---|---|
| Create a customer | POST /v1/customers |
| Update a customer | POST /v1/customers/:id |
| Delete a customer | DELETE /v1/customers/:id |
| Create a bank account | POST /v1/customers/:customer/bank_accounts |
| Update a bank account | POST /v1/customers/:customer/bank_accounts/:id |
| Delete a bank account | DELETE /v1/customers/:customer/bank_accounts/:id |
| Verify a bank account | POST /v1/customers/:customer/bank_accounts/:id/verify |
Disputes
| Endpoint | Path |
|---|---|
| Update a dispute | POST /v1/disputes/:dispute |
| Close a dispute | POST /v1/disputes/:dispute/close |
Entitlements
| Endpoint | Path |
|---|---|
| Create a feature | POST /the relevant part of the product |
| Update a feature | POST /the relevant part of the product/:id |
Invoice Items
| Endpoint | Path |
|---|---|
| Create an invoice item | POST /v1/invoiceitems |
| Update an invoice item | POST /v1/invoiceitems/:id |
| Delete an invoice item | DELETE /v1/invoiceitems/:id |
Invoices
| Endpoint | Path |
|---|---|
| Update an invoice | POST /v1/invoices/:id |
| Bulk add invoice line items | POST /v1/invoices/:invoice/add_lines |
Prices
| Endpoint | Path |
|---|---|
| Update a price | POST /v1/prices/:id |
Products
| Endpoint | Path |
|---|---|
| Create a product | POST /v1/products |
| Update a product | POST /v1/products/:id |
| Delete a product | DELETE /v1/products/:id |
| Create a product feature | POST /v1/products/:product/features |
| Delete a product feature | DELETE /v1/products/:product/features/:id |
Promotion Codes
| Endpoint | Path |
|---|---|
| Create a promotion code | POST /v1/promotion_codes |
| Update a promotion code | POST /v1/promotion_codes/:id |
Radar
| Endpoint | Path |
|---|---|
| Create a value list item | POST /the relevant part of the product |
Subscription Items
| Endpoint | Path |
|---|---|
| Update a subscription item | POST /v1/subscription_items/:item |
| Delete a subscription item | DELETE /v1/subscription_items/:item |
Subscription Schedules
| Endpoint | Path |
|---|---|
| Create a schedule | POST /v1/subscription_schedules |
| Update a schedule | POST /v1/subscription_schedules/:id |
| Cancel a schedule | POST /v1/subscription_schedules/:id/cancel |
| Release a schedule | POST /v1/subscription_schedules/:schedule/release |
Subscriptions
| Endpoint | Path |
|---|---|
| Update a subscription | POST /v1/subscriptions/:id |
| Migrate a subscription | POST /v1/subscriptions/:id/migrate |
| Cancel a subscription | DELETE /v1/subscriptions/:id |
| Create a subscription | POST /v1/subscriptions |
Tax
| Endpoint | Path |
|---|---|
| Create a tax rate | POST /v1/tax_rates |
| Update a tax rate | POST /v1/tax_rates/:id |
| Create a registration | POST /the relevant part of the product |
| Update a registration | POST /the relevant part of the product/:id |
| Update settings | POST /the relevant part of the product |
Transfers
| Endpoint | Path |
|---|---|
| Create a transfer | POST /v1/transfers |
| Update a transfer | POST /v1/transfers/:id |
Plans
| Endpoint | Path |
|---|---|
| Create a plan | POST /v1/plans |
| Update a plan | POST /v1/plans/:id |
| Delete a plan | DELETE /v1/plans/:id |
Others
| Endpoint | Path |
|---|