Skip to main content
POST
Align selected product subscriptions atomically

Authorizations

Authorization
string
header
required

A member credential in the Authorization: Bearer header: a member session JWT, a portal JWT whose login is linked to a membership in that company, or an opaque member token. The credential alone identifies the member and company.

Body

application/json
subscription_ids
string<uuid>[]
required

Distinct public UUIDs of the member's selected subscriptions. UUID comparison ignores case.

Required array length: 2 - 100 elements
next_bill_date
string<date>
required

Calendar bill date in the resolved bundle timezone; cannot be in the past.

Pattern: ^\d{4}-\d{2}-\d{2}$
address_id
string<uuid>

Public UUID of an owned address. Required for physical subscriptions; omit for digital subscriptions.

timezone
string

IANA timezone used when the selected subscriptions do not already share one.

Maximum string length: 255
Example:

"America/Los_Angeles"

Response

Every selected subscription was aligned successfully. Only the selected subscriptions are returned.

status
integer
required

HTTP success status.

data
object[]
required

Explicitly selected subscriptions and their persisted billing instants.

Required array length: 2 - 100 elements
meta
object
required

Envelope metadata present on every response.