Skip to main content
GET
Get subscription

Path Parameters

uuid
string
required

A universally unique identifier (UUID), typically used for images or other resources.

Response

200 - application/json

Returns the subscription details including status and configuration.

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