Skip to main content
POST
cURL
Part of the Subscription Connector integration guide — see it for when and how to use this endpoint.
The status of the payment arrives through Recurring payment notifications.

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

Represents a recurring payment creation event.

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
required

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

products
object[]
required

List of products

Minimum array length: 1
discounts
object[]
required

Discounts applied to this cycle. The property must be present; send an empty array when no discount applies.

payment
object
required

Payment details. For physical / hybrid subscriptions, shippingAmount is required and is charged as-is: Global-e does not recalculate any amount while applying payment.

Response

Request accepted.

description
string
required

Human-readable message