v1

latestOpenAPI 3.1.02026-07-24170121.2 MB

Update a Plan

This API updates an existing plan.

patch/v1/plans/{plan_id}

Path parameters

plan_idstring required

plan_id here updates the information of the unique Plan ID.

Headers

Acceptstring required

Indicates which content types, expressed as MIME types, the client is able to understand.

Content-Typestring required

Indicates the media type of the resource sent in the HTTP message body. <br /><br /><b>Possible Values:</b><br /> application/json<br />application/x-www-form-urlencoded

Request body

namestring required

Name of the plan.<br><table style='width: 100%; border-collapse: collapse;'><tr><td style='text-align: center;'><b>Format</b></td><td style='text-align: center;'><b>Min Length</b></td><td style='text-align: center;'><b>Max Length</b></td><td style='text-align: center;'><b>Examples</b></td></tr><tr><td>Alphanumeric and Special Characters</td><td>3 characters</td><td>50 characters</td><td>mynewplanname</td></tr></table>

statement_descriptorstring

An arbitrary string to be displayed on a plan.<br><table style='width: 100%; border-collapse: collapse;'><tr><td style='text-align: center;'><b>Format</b></td><td style='text-align: center;'><b>Min Length</b></td><td style='text-align: center;'><b>Max Length</b></td><td style='text-align: center;'><b>Examples</b></td></tr><tr><td>Alphanumeric and Special Characters</td><td>5 characters</td><td>25 characters</td><td>A1 Company 888-888-8888</td></tr></table>

trial_period_daysinteger

Number of days of the trial period that a customer is not charged for.<br><style>td { padding: 2px 4px; border: 1px solid #ddd; font-size: 0.65em; line-height: 1.2; }</style><table style='width: 100%; border-collapse: collapse;'><tr><td style='text-align: center;'><b>Format</b></td><td style='text-align: center;'><b>Allowed Values</b></td></tr><tr><td>Numeric</td><td>0 - 365</td></tr></table>

Response

200

Example response

{
  "data": {
    "object": "Plan",
    "plan_id": "plan_d2b50d00",
    "amount": 99,
    "interval": "day",
    "interval_count": 1,
    "name": "Testers",
    "statement_descriptor": "dfghdfhg",
    "trial_period_days": "0",
    "currency": "usd",
    "created_at": 1724503321,
    "updated_at": 1724505274
  }
}