Skip to main content
POST
Create subscription

Body

application/json

Data to create a new resource at /subscriptions

Request payload for creating a new subscription. Contains subscription package selection, billing configuration, and optional customization settings.

sellerId
integer<int64>
required

Required seller for which to make a subscription.

entity
enum<string>
required

Required entity name for which to subscribe.
Enum: ORDERS SHIPMENTS

Available options:
SHIPMENTS,
ORDERS,
INBOUNDS,
RETURNS,
INVOICES
endpoint
object
required

Response object containing endpoint details

Response

200 - application/json

Returns the newly created subscription with assigned identifier and status.

Subscription information and details. Contains subscription package, billing configuration, status, and usage metrics.

sellerId
integer<int64>
required

Required seller for which to make a subscription.

entity
enum<string>
required

Required entity name for which to subscribe.
Enum: ORDERS SHIPMENTS

Available options:
SHIPMENTS,
ORDERS,
INBOUNDS,
RETURNS,
INVOICES
endpoint
object
required

Response object containing endpoint details

uuid
string

The uuid value