Hermos API

Switch a live subscription product

Replaces the selected product line and its components. Quantities carry unless specified. Requires a merchant person or key. Unsupported subscription notice shapes return 422 notice_unsupported_shape before processor preview. Changes to switch inputs during preview are revalidated under the subscription lock. Proration defaults to bill_now. With downgrade_timing=renewal, cheaper same-interval changes and longer-to-shorter interval changes take effect at the end of the paid period. Fixed-day cross-interval switches are deferred to HERM-60 PR 4.

POST/subscriptions/{subscription}/switch_product

Replaces the selected product line and its components. Quantities carry unless specified. Requires a merchant person or key. Unsupported subscription notice shapes return 422 notice_unsupported_shape before processor preview. Changes to switch inputs during preview are revalidated under the subscription lock. Proration defaults to bill_now. With downgrade_timing=renewal, cheaper same-interval changes and longer-to-shorter interval changes take effect at the end of the paid period. Fixed-day cross-interval switches are deferred to HERM-60 PR 4.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

subscription*string

Opaque subscription ID.

Match^sbs_[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/switch_product" \  -H "Content-Type: application/json" \  -d '{    "new_price": "string"  }'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "status": "string",  "approval": {    "id": "string",    "expires_at": "2019-08-24T14:15:22Z"  }}