Authorizations
Path Parameters
Body
application/json
curl --request POST \
--url https://app.flowglad.com/api/v1/subscriptions/{id}/adjust \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"adjustment": {
"timing": "<string>",
"newSubscriptionItems": [
{
"subscriptionId": "<string>",
"name": "<string>",
"addedDate": "<string>",
"priceId": "<string>",
"unitPrice": 123,
"quantity": 123,
"usageEventsPerUnit": null,
"usageMeterId": null,
"metadata": {},
"type": "<string>",
"externalId": "<string>",
"expiredAt": "<string>"
}
],
"prorateCurrentBillingPeriod": true
}
}'
{
"subscription": {
"id": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"createdByCommit": "<string>",
"updatedByCommit": "<string>",
"livemode": true,
"startDate": "<string>",
"customerId": "<string>",
"organizationId": "<string>",
"status": "trialing",
"defaultPaymentMethodId": "<string>",
"backupPaymentMethodId": "<string>",
"trialEnd": "<string>",
"currentBillingPeriodStart": "<string>",
"currentBillingPeriodEnd": "<string>",
"metadata": {},
"canceledAt": "<string>",
"cancelScheduledAt": "<string>",
"cancellationReason": "<string>",
"replacedBySubscriptionId": "<string>",
"isFreePlan": true,
"priceId": "<string>",
"runBillingAtPeriodStart": true,
"interval": "day",
"intervalCount": "<any>",
"billingCycleAnchorDate": "<string>",
"name": "<string>",
"renews": true,
"current": true
},
"subscriptionItems": [
{
"id": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"createdByCommit": "<string>",
"updatedByCommit": "<string>",
"livemode": true,
"subscriptionId": "<string>",
"name": "<string>",
"addedDate": "<string>",
"priceId": "<string>",
"unitPrice": "<any>",
"quantity": "<any>",
"usageEventsPerUnit": null,
"usageMeterId": null,
"metadata": {},
"type": "<string>",
"externalId": "<string>",
"expiredAt": "<string>"
}
]
}
curl --request POST \
--url https://app.flowglad.com/api/v1/subscriptions/{id}/adjust \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"adjustment": {
"timing": "<string>",
"newSubscriptionItems": [
{
"subscriptionId": "<string>",
"name": "<string>",
"addedDate": "<string>",
"priceId": "<string>",
"unitPrice": 123,
"quantity": 123,
"usageEventsPerUnit": null,
"usageMeterId": null,
"metadata": {},
"type": "<string>",
"externalId": "<string>",
"expiredAt": "<string>"
}
],
"prorateCurrentBillingPeriod": true
}
}'
{
"subscription": {
"id": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"createdByCommit": "<string>",
"updatedByCommit": "<string>",
"livemode": true,
"startDate": "<string>",
"customerId": "<string>",
"organizationId": "<string>",
"status": "trialing",
"defaultPaymentMethodId": "<string>",
"backupPaymentMethodId": "<string>",
"trialEnd": "<string>",
"currentBillingPeriodStart": "<string>",
"currentBillingPeriodEnd": "<string>",
"metadata": {},
"canceledAt": "<string>",
"cancelScheduledAt": "<string>",
"cancellationReason": "<string>",
"replacedBySubscriptionId": "<string>",
"isFreePlan": true,
"priceId": "<string>",
"runBillingAtPeriodStart": true,
"interval": "day",
"intervalCount": "<any>",
"billingCycleAnchorDate": "<string>",
"name": "<string>",
"renews": true,
"current": true
},
"subscriptionItems": [
{
"id": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"createdByCommit": "<string>",
"updatedByCommit": "<string>",
"livemode": true,
"subscriptionId": "<string>",
"name": "<string>",
"addedDate": "<string>",
"priceId": "<string>",
"unitPrice": "<any>",
"quantity": "<any>",
"usageEventsPerUnit": null,
"usageMeterId": null,
"metadata": {},
"type": "<string>",
"externalId": "<string>",
"expiredAt": "<string>"
}
]
}
Show child attributes
Was this page helpful?