PATCH
/
plans
/
{id}
curl --request PATCH \
  --url https://api.sulu.sh/v0/plans/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "invoiceDisplayName": "<string>",
  "description": "<string>",
  "billingInterval": "monthly",
  "currency": "<string>",
  "tax": {},
  "prices": [
    "<string>"
  ]
}'
{
  "id": "<string>",
  "object": "plan",
  "name": "<string>",
  "invoiceDisplayName": "<string>",
  "description": "<string>",
  "billingInterval": "<string>",
  "currency": "<string>",
  "merchantId": "<string>",
  "productId": "<string>",
  "tax": {},
  "prices": [
    {
      "id": "<string>",
      "object": "price",
      "billableMetricId": "<string>",
      "model": "standard",
      "invoiceDisplayName": "<string>",
      "properties": {
        "unitPrice": "<string>"
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Unique identifier for a plan

Body

application/json
name
string
invoiceDisplayName
string
description
string
billingInterval
enum<string>
Available options:
monthly,
yearly
currency
string
tax
object
prices
string[]

Response

200
application/json
Plan updated successfully
id
string

Unique identifier for a plan

object
enum<string>
Available options:
plan
name
string
invoiceDisplayName
string
description
string
billingInterval
string
currency
string
merchantId
string

The merchant organization that owns this plan

productId
string

The product this plan belongs to

tax
object
prices
object[]
createdAt
string
updatedAt
string
deletedAt
string