Skip to main content
PUT
Update Subscription contract frequency by compatible selling-plan frequency

Headers

X-API-Key
string
required

API Key for authentication

Query Parameters

contractId
integer<int64>
required

Subscription contract ID to update. Provide the numeric ID without the gid:// prefix

Required range: x >= 1
frequencyKey
string

Compatible frequency key returned by /api/data/external/v2/compatible-selling-plan-frequencies

sellingPlanId
integer<int64>

A selling plan ID from a compatible frequency option. Provide the numeric ID without gid:// prefix.

Required range: x >= 1

Response

200 - */*

OK

billingAttempts
object
billingPolicy
object
createdAt
object
customAttributes
object[]
customer
object
customerPaymentMethod
object
deliveryMethod
object
deliveryPolicy
object
deliveryPrice
object
discounts
object
get__typename
string
id
string
lastPaymentStatus
enum<string>
Available options:
SUCCEEDED,
FAILED,
$UNKNOWN
lines
object
nextBillingDate
object
note
string
originOrder
object
status
enum<string>
Available options:
ACTIVE,
PAUSED,
CANCELLED,
EXPIRED,
FAILED,
$UNKNOWN
updatedAt
object