Schedules or clears end-of-period cancellation of the live subscription.

PATCH

/v1/billing/subscription

• Reverse-proxied API origin

A JSON Merge Patch. Access stays until currentPeriodEnd. An account in Orbit by an operator’s grant has no subscription, so there is none here to change.

Authorizations

• bearerAuth

Request Body^required

Media typeapplication/merge-patch+json

Sets whether the subscription cancels at the end of its paid period.

object

cancelAtPeriodEnd

required

boolean

Example^generated

{
  "cancelAtPeriodEnd": true
}

Responses

200

The subscription as Stripe now holds it

Media typeapplication/json

Subscription state mirrored from Stripe.

object

cancelAtPeriodEnd

required

True when an auto-renewing subscription ends at currentPeriodEnd.

boolean

currentPeriodEnd

string format: date-time

plan

Absent until a plan is purchased.

string

Allowed values: monthly yearly

status

required

Stripe’s subscription status verbatim. An open vocabulary Stripe owns, so an unknown status must reach the client rather than fail the response.

string

Example

{
  "plan": "monthly"
}

400

The request is malformed

Media typeapplication/problem+json

RFC 9457 problem details payload.

object

detail

Explanation specific to this occurrence, written to help correct the request.

string

errors

The invalid members of the request. Present on a validation problem.

Array<object>

One invalid member of a request, located by a JSON Pointer (RFC 6901).

object

detail

required

What is wrong with it.

string

pointer

required

JSON Pointer to the member within the request body. Empty for the whole body.

string

status

required

HTTP status code.

integer format: int32

title

required

Short summary of the problem type. For about:blank, the status phrase.

string

type

Problem type URI, which resolves to its documentation. Absent means about:blank.

string

Example^generated

{
  "detail": "example",
  "errors": [
    {
      "detail": "example",
      "pointer": "example"
    }
  ],
  "status": 1,
  "title": "example",
  "type": "example"
}

401

No valid session token

Media typeapplication/problem+json

RFC 9457 problem details payload.

object

detail

Explanation specific to this occurrence, written to help correct the request.

string

errors

The invalid members of the request. Present on a validation problem.

Array<object>

One invalid member of a request, located by a JSON Pointer (RFC 6901).

object

detail

required

What is wrong with it.

string

pointer

required

JSON Pointer to the member within the request body. Empty for the whole body.

string

status

required

HTTP status code.

integer format: int32

title

required

Short summary of the problem type. For about:blank, the status phrase.

string

type

Problem type URI, which resolves to its documentation. Absent means about:blank.

string

Example^generated

{
  "detail": "example",
  "errors": [
    {
      "detail": "example",
      "pointer": "example"
    }
  ],
  "status": 1,
  "title": "example",
  "type": "example"
}

Headers

WWW-Authenticate

string

The Bearer challenge (RFC 6750).

404

No live subscription

Media typeapplication/problem+json

RFC 9457 problem details payload.

object

detail

Explanation specific to this occurrence, written to help correct the request.

string

errors

The invalid members of the request. Present on a validation problem.

Array<object>

One invalid member of a request, located by a JSON Pointer (RFC 6901).

object

detail

required

What is wrong with it.

string

pointer

required

JSON Pointer to the member within the request body. Empty for the whole body.

string

status

required

HTTP status code.

integer format: int32

title

required

Short summary of the problem type. For about:blank, the status phrase.

string

type

Problem type URI, which resolves to its documentation. Absent means about:blank.

string

Example^generated

{
  "detail": "example",
  "errors": [
    {
      "detail": "example",
      "pointer": "example"
    }
  ],
  "status": 1,
  "title": "example",
  "type": "example"
}

413

The body is too large

Media typeapplication/problem+json

RFC 9457 problem details payload.

object

detail

Explanation specific to this occurrence, written to help correct the request.

string

errors

The invalid members of the request. Present on a validation problem.

Array<object>

One invalid member of a request, located by a JSON Pointer (RFC 6901).

object

detail

required

What is wrong with it.

string

pointer

required

JSON Pointer to the member within the request body. Empty for the whole body.

string

status

required

HTTP status code.

integer format: int32

title

required

Short summary of the problem type. For about:blank, the status phrase.

string

type

Problem type URI, which resolves to its documentation. Absent means about:blank.

string

Example^generated

{
  "detail": "example",
  "errors": [
    {
      "detail": "example",
      "pointer": "example"
    }
  ],
  "status": 1,
  "title": "example",
  "type": "example"
}

415

The body is not a JSON Merge Patch

Media typeapplication/problem+json

RFC 9457 problem details payload.

object

detail

Explanation specific to this occurrence, written to help correct the request.

string

errors

The invalid members of the request. Present on a validation problem.

Array<object>

One invalid member of a request, located by a JSON Pointer (RFC 6901).

object

detail

required

What is wrong with it.

string

pointer

required

JSON Pointer to the member within the request body. Empty for the whole body.

string

status

required

HTTP status code.

integer format: int32

title

required

Short summary of the problem type. For about:blank, the status phrase.

string

type

Problem type URI, which resolves to its documentation. Absent means about:blank.

string

Example^generated

{
  "detail": "example",
  "errors": [
    {
      "detail": "example",
      "pointer": "example"
    }
  ],
  "status": 1,
  "title": "example",
  "type": "example"
}

Headers

Accept-Patch

string

The patch media type the operation takes (RFC 5789).

429

Too many requests

Media typeapplication/problem+json

RFC 9457 problem details payload.

object

detail

Explanation specific to this occurrence, written to help correct the request.

string

errors

The invalid members of the request. Present on a validation problem.

Array<object>

One invalid member of a request, located by a JSON Pointer (RFC 6901).

object

detail

required

What is wrong with it.

string

pointer

required

JSON Pointer to the member within the request body. Empty for the whole body.

string

status

required

HTTP status code.

integer format: int32

title

required

Short summary of the problem type. For about:blank, the status phrase.

string

type

Problem type URI, which resolves to its documentation. Absent means about:blank.

string

Example^generated

{
  "detail": "example",
  "errors": [
    {
      "detail": "example",
      "pointer": "example"
    }
  ],
  "status": 1,
  "title": "example",
  "type": "example"
}

Headers

Retry-After

string

Seconds to wait. Sent when the limit knows when it lifts.

500

The service failed

Media typeapplication/problem+json

RFC 9457 problem details payload.

object

detail

Explanation specific to this occurrence, written to help correct the request.

string

errors

The invalid members of the request. Present on a validation problem.

Array<object>

One invalid member of a request, located by a JSON Pointer (RFC 6901).

object

detail

required

What is wrong with it.

string

pointer

required

JSON Pointer to the member within the request body. Empty for the whole body.

string

status

required

HTTP status code.

integer format: int32

title

required

Short summary of the problem type. For about:blank, the status phrase.

string

type

Problem type URI, which resolves to its documentation. Absent means about:blank.

string

Example^generated

{
  "detail": "example",
  "errors": [
    {
      "detail": "example",
      "pointer": "example"
    }
  ],
  "status": 1,
  "title": "example",
  "type": "example"
}

503

Billing unavailable

Media typeapplication/problem+json

RFC 9457 problem details payload.

object

detail

Explanation specific to this occurrence, written to help correct the request.

string

errors

The invalid members of the request. Present on a validation problem.

Array<object>

One invalid member of a request, located by a JSON Pointer (RFC 6901).

object

detail

required

What is wrong with it.

string

pointer

required

JSON Pointer to the member within the request body. Empty for the whole body.

string

status

required

HTTP status code.

integer format: int32

title

required

Short summary of the problem type. For about:blank, the status phrase.

string

type

Problem type URI, which resolves to its documentation. Absent means about:blank.

string

Example^generated

{
  "detail": "example",
  "errors": [
    {
      "detail": "example",
      "pointer": "example"
    }
  ],
  "status": 1,
  "title": "example",
  "type": "example"
}