Hermos API

Grant one free renewal

Accept a free-period offer from an opened cancel flow, or grant it as a merchant with a reason. Applies the reserved 100%-off once coupon without proration or a trial. Access stays prepaid. Monthly-only: yearly and weekly billing are refused with not_yet_available. Existing discounts fail asynchronously. A dashboard discount added between the preflight read and mutation is replaced. Not yet available: free-period grants are refused independently of pause and skip.

POST/subscriptions/{subscription}/free_period

Accept a free-period offer from an opened cancel flow, or grant it as a merchant with a reason. Applies the reserved 100%-off once coupon without proration or a trial. Access stays prepaid. Monthly-only: yearly and weekly billing are refused with not_yet_available. Existing discounts fail asynchronously. A dashboard discount added between the preflight read and mutation is replaced. Not yet available: free-period grants are refused independently of pause and skip.

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/free_period" \  -H "Content-Type: application/json" \  -d '{}'
{  "subscription_id": "string",  "offer": "free_period",  "periods": 1,  "currency": "usd",  "exposure": 0,  "next_billing_at": "2019-08-24T14:15:22Z",  "steps": [    {      "name": "ensureFreePeriodCoupon",      "args": {        "property1": null,        "property2": null      }    }  ],  "action_hash": "string"}