Hermos API

Change a live subscription item quantity

For active, trialing or past_due subscriptions. Increases and decreases apply immediately using the product proration setting, preserving the billing date. Flat per-unit licensed seats and plain per-unit metered components support renewal notices. Tiered, package, decimal and special-term components, and other unsupported resulting shapes, return notice_unsupported_shape. An unchanged quantity returns 409 quantity_unchanged without an operation. Bill-now changes refuse an unsuccessful immediate payment. Requires a merchant person or key; agent approvals and customer sessions are not supported.

POST/subscriptions/{subscription}/items/{item}/quantity

For active, trialing or past_due subscriptions. Increases and decreases apply immediately using the product proration setting, preserving the billing date. Flat per-unit licensed seats and plain per-unit metered components support renewal notices. Tiered, package, decimal and special-term components, and other unsupported resulting shapes, return notice_unsupported_shape. An unchanged quantity returns 409 quantity_unchanged without an operation. Bill-now changes refuse an unsuccessful immediate payment. Requires a merchant person or key; agent approvals and customer sessions are not supported.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

subscription*string

Opaque subscription ID.

Match^sbs_[0-7][0-9abcdefghjkmnpqrstvwxyz]{25}$(?![\s\S])
item*string

Opaque subscription item ID.

Match^sbi_[0-7][0-9abcdefghjkmnpqrstvwxyz]{25}$(?![\s\S])

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/subscriptions/string/items/string/quantity" \  -H "Content-Type: application/json" \  -d '{    "quantity": 0  }'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "status": "string",  "approval": {    "id": "string",    "expires_at": "2019-08-24T14:15:22Z"  }}