POST
/
subscriptions
/
{id}
/
phases
curl --request POST \
  --url https://api.cloud.flexprice.com/v1/subscriptions/{id}/phases \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "phase": {
    "billing_cycle": "anniversary",
    "commitment_amount": 123,
    "credit_grants": [
      {
        "cadence": "ONETIME",
        "credits": 123,
        "currency": "<string>",
        "expiration_duration": 123,
        "expiration_duration_unit": "DAY",
        "expiration_type": "NEVER",
        "metadata": {},
        "name": "<string>",
        "period": "DAILY",
        "period_count": 123,
        "plan_id": "<string>",
        "priority": 123,
        "scope": "PLAN",
        "subscription_id": "<string>"
      }
    ],
    "end_date": "<string>",
    "line_items": [
      {
        "display_name": "<string>",
        "metadata": {},
        "price_id": "<string>",
        "quantity": 123
      }
    ],
    "metadata": {},
    "overage_factor": 123,
    "start_date": "<string>"
  }
}'
{
  "created_at": "<string>",
  "current_phase_index": 123,
  "end_behavior": "RELEASE",
  "id": "<string>",
  "phases": [
    {
      "commitment_amount": 123,
      "created_at": "<string>",
      "credit_grants": [
        {
          "cadence": "ONETIME",
          "created_at": "<string>",
          "created_by": "<string>",
          "credits": 123,
          "currency": "<string>",
          "environment_id": "<string>",
          "expiration_duration": 123,
          "expiration_duration_unit": "DAY",
          "expiration_type": "NEVER",
          "id": "<string>",
          "metadata": {},
          "name": "<string>",
          "period": "DAILY",
          "period_count": 123,
          "plan_id": "<string>",
          "priority": 123,
          "scope": "PLAN",
          "status": "published",
          "subscription_id": "<string>",
          "tenant_id": "<string>",
          "updated_at": "<string>",
          "updated_by": "<string>"
        }
      ],
      "end_date": "<string>",
      "id": "<string>",
      "line_items": [
        {
          "billing_period": "MONTHLY",
          "created_at": "<string>",
          "created_by": "<string>",
          "currency": "<string>",
          "customer_id": "<string>",
          "display_name": "<string>",
          "end_date": "<string>",
          "environment_id": "<string>",
          "id": "<string>",
          "invoice_cadence": "ARREAR",
          "metadata": {},
          "meter_display_name": "<string>",
          "meter_id": "<string>",
          "plan_display_name": "<string>",
          "plan_id": "<string>",
          "price_id": "<string>",
          "price_type": "USAGE",
          "quantity": 123,
          "start_date": "<string>",
          "status": "published",
          "subscription_id": "<string>",
          "tenant_id": "<string>",
          "trial_period": 123,
          "updated_at": "<string>",
          "updated_by": "<string>"
        }
      ],
      "overage_factor": 123,
      "phase_index": 123,
      "schedule_id": "<string>",
      "start_date": "<string>",
      "updated_at": "<string>"
    }
  ],
  "start_date": "<string>",
  "status": "ACTIVE",
  "subscription_id": "<string>",
  "updated_at": "<string>"
}

Authorizations

​
x-api-key
string
header
required

Enter your API key in the format x-api-key <api-key>*

Path Parameters

​
id
string
required

Subscription ID

Body

application/json

Add schedule phase request

The body is of type object.

Response

200
application/json

OK

The response is of type object.