Skip to main content
POST
cURL
Part of the Subscription Connector integration guide — see it for when and how to use this endpoint.

Headers

Idempotency-Key
string<uuid>
required

Unique identifier for the request; the same value must be sent on retries so the operation is applied at most once.

Body

application/json

A subscription creation event.

orderId
string
required

Unique order identifier in Global-e

products
string[]
required

List of products codes

Minimum array length: 1

Unique product identifier

notificationType
enum<string>
required

Which subscription lifecycle event this notification reports.

  • SUBSCRIPTION_CREATED — a subscription has been created
  • ADDRESS_UPDATE — the subscription's shipping address has changed
Available options:
SUBSCRIPTION_CREATED,
ADDRESS_UPDATE
subscriptionId
string
required

Unique identifier of subscription in the subscription manager.

Maximum string length: 100
merchantGuid
string<uuid>
required

Global-e merchant unique identifier

externalReferenceId
string

Unique identifier of external document object, like invoiceId in the subscription manager

Response

Request accepted.

description
string
required

Human-readable message