Change a line's price

curl --request POST \
  --url https://www.carstoragesoftware.com/api/v1/billing/subscriptions/{id}/change-price \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "line": {
    "lineId": "<string>",
    "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "carId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "amountCents": 5000000,
  "priceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "confirm": true,
  "previewToken": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    line: {
      lineId: '<string>',
      productId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      carId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    },
    amountCents: 5000000,
    priceId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    confirm: true,
    previewToken: '<string>'
  })
};

fetch('https://www.carstoragesoftware.com/api/v1/billing/subscriptions/{id}/change-price', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://www.carstoragesoftware.com/api/v1/billing/subscriptions/{id}/change-price"

payload = {
    "line": {
        "lineId": "<string>",
        "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "carId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "amountCents": 5000000,
    "priceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "confirm": True,
    "previewToken": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "data": {
    "applied": true,
    "summary": "<string>",
    "action": "<string>",
    "previewToken": "<string>",
    "customerName": "<string>",
    "currency": "<string>",
    "interval": "<string>",
    "nextBillAt": "<string>",
    "before": {
      "lines": [
        {
          "lineId": "<string>",
          "productName": "<string>",
          "unitAmountCents": 123,
          "quantity": 123,
          "carLabel": "<string>",
          "change": "added"
        }
      ],
      "totalCents": 123
    },
    "after": {
      "lines": [
        {
          "lineId": "<string>",
          "productName": "<string>",
          "unitAmountCents": 123,
          "quantity": 123,
          "carLabel": "<string>",
          "change": "added"
        }
      ],
      "totalCents": 123
    },
    "newPriceWillBeCreated": true,
    "message": "<string>"
  }
}

{
  "error": "<string>",
  "code": "<string>",
  "details": null
}

{
  "error": "<string>",
  "code": "<string>",
  "details": null
}

{
  "error": "<string>",
  "code": "<string>",
  "details": null
}

{
  "error": "<string>",
  "code": "<string>",
  "details": null
}

{
  "error": "<string>",
  "code": "<string>",
  "details": null
}

Billing

Change a line's price

Requires write:billing. Change the recurring price of one line (e.g. monthly storage from $350 to$ 400). Without confirm, nothing changes and the response has a plain-language summary, the plan before and after, and a previewToken. Calling again with the same arguments plus confirm: true and that previewToken applies the change. Takes effect with the next bill (no proration, nothing charged now). A stale token (the plan changed since the preview) is refused with 409; preview again.

POST

api

billing

subscriptions

{id}

change-price

Change a line's price

curl --request POST \
  --url https://www.carstoragesoftware.com/api/v1/billing/subscriptions/{id}/change-price \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "line": {
    "lineId": "<string>",
    "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "carId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "amountCents": 5000000,
  "priceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "confirm": true,
  "previewToken": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    line: {
      lineId: '<string>',
      productId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      carId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    },
    amountCents: 5000000,
    priceId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    confirm: true,
    previewToken: '<string>'
  })
};

fetch('https://www.carstoragesoftware.com/api/v1/billing/subscriptions/{id}/change-price', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://www.carstoragesoftware.com/api/v1/billing/subscriptions/{id}/change-price"

payload = {
    "line": {
        "lineId": "<string>",
        "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "carId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "amountCents": 5000000,
    "priceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "confirm": True,
    "previewToken": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "data": {
    "applied": true,
    "summary": "<string>",
    "action": "<string>",
    "previewToken": "<string>",
    "customerName": "<string>",
    "currency": "<string>",
    "interval": "<string>",
    "nextBillAt": "<string>",
    "before": {
      "lines": [
        {
          "lineId": "<string>",
          "productName": "<string>",
          "unitAmountCents": 123,
          "quantity": 123,
          "carLabel": "<string>",
          "change": "added"
        }
      ],
      "totalCents": 123
    },
    "after": {
      "lines": [
        {
          "lineId": "<string>",
          "productName": "<string>",
          "unitAmountCents": 123,
          "quantity": 123,
          "carLabel": "<string>",
          "change": "added"
        }
      ],
      "totalCents": 123
    },
    "newPriceWillBeCreated": true,
    "message": "<string>"
  }
}

{
  "error": "<string>",
  "code": "<string>",
  "details": null
}

{
  "error": "<string>",
  "code": "<string>",
  "details": null
}

{
  "error": "<string>",
  "code": "<string>",
  "details": null
}

{
  "error": "<string>",
  "code": "<string>",
  "details": null
}

{
  "error": "<string>",
  "code": "<string>",
  "details": null
}

Authorizations

Authorization

string

header

required

Team API key from Settings → Integrations. Use Authorization: Bearer <key> or x-api-key.

Path Parameters

string<uuid>

required

Subscription id from list_billing_subscriptions.

Body

application/json

line

object

Which line of the plan to change. Optional when the plan has one line; otherwise pass one of these.

Show child attributes

amountCents

integer

Price per billing period in cents (e.g. 35000 = $350.00), before tax and processing fees.

Required range: 0 <= x <= 10000000

priceId

string<uuid>

confirm

boolean

Leave out (or false) to preview: nothing changes, and the response has a summary and previewToken. With confirm: true and that previewToken, the change is applied.

previewToken

string

From the preview. Required with confirm: true; refused if the plan or the change differs from what was previewed.

Maximum string length: 100

Response

Preview (applied: false) or applied change (applied: true).

data

object

required

Show child attributes

Get started

Cars

Customers

Contacts

Locations

Parking

Event types

Appointments

Billing

Communications

Marketing

Change a line's price

Authorizations

Path Parameters

Body

Response