Attach Stripe ids to a plan version

PATCH

/billing/admin/plans/{id}/stripe

curl --request PATCH \
  --url https://api.sloose.com/billing/admin/plans/pv_business_3/stripe \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "stripeProductId": "example", "stripePriceMonthlyId": "example", "stripePriceAnnualId": "example", "stripePriceOverageId": "example" }'

• Production

Backoffice route: a staff session, or ADMIN_TOKEN; never a customer’s session. Run after creating the products and prices in Stripe. Only the fields you send change.

Authorizations

• sessionAuth
• adminToken

Parameters

Path Parameters

id

required

The plan version id.

string

Example

pv_business_3

The plan version id.

Request Body^required

Media typeapplication/json

object

stripeProductId

string | null

stripePriceMonthlyId

string | null

stripePriceAnnualId

string | null

stripePriceOverageId

string | null

key

additional properties

Example^generated

{
  "stripeProductId": "example",
  "stripePriceMonthlyId": "example",
  "stripePriceAnnualId": "example",
  "stripePriceOverageId": "example"
}

Responses

200

The plan version as it now stands.

Media typeapplication/json

object

key

additional properties

Example^generated

{
  "additionalProperty": "example"
}

401

A bearer that is neither the token nor a live session (code: AUTH_REQUIRED).

Media typeapplication/json

The error envelope every non-2xx answer uses.

object

error

required

Human-readable explanation.

string

code

Machine-readable reason. Absent on a few legacy 400s.

string

key

additional properties

Example^generated

{
  "error": "example",
  "code": "example"
}

403

A customer’s session, an API token, or no bearer at all — not staff, and not the ADMIN_TOKEN (code: ADMIN_REQUIRED).

Media typeapplication/json

The error envelope every non-2xx answer uses.

object

error

required

Human-readable explanation.

string

code

Machine-readable reason. Absent on a few legacy 400s.

string

key

additional properties

Example^generated

{
  "error": "example",
  "code": "example"
}

404

No such plan version.

Media typeapplication/json

object

error

required

string

key

additional properties

Example^generated

{
  "error": "example"
}

503

The restore switch is on (code: MAINTENANCE): every route but /health and /robots.txt is refused before anything is read, except the operator’s own POST /staff/people/{id}/delete with the ADMIN_TOKEN. Sloose is down for maintenance. Please try again in a few minutes.

Media typeapplication/json

object

error

required

string

code

required

string

Allowed value: MAINTENANCE

Example

{
  "code": "MAINTENANCE"
}

Headers

Retry-After

integer

Seconds until asking again is worth it (300 while the switch is on).