Preview commitment

Validates a commitment and returns its computed value without creating it.

POST /commitments/preview

cURL

cURL

curl --request POST \
  --url https://us.api.flexprice.io/v1/commitments/preview \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "scope": {
    "entity_id": "<string>"
  },
  "start_date": "2023-11-07T05:31:56Z",
  "active_windows": [
    {
      "end": {
        "hour": 12,
        "minute": 29
      },
      "start": {
        "hour": 12,
        "minute": 29
      }
    }
  ],
  "binding": true,
  "committed_price": {
    "amount": "<string>",
    "tiers": [
      {
        "unit_amount": "<string>",
        "flat_amount": "<string>",
        "transform_quantity": {
          "divide_by": 123
        },
        "up_to": 123
      }
    ],
    "transform_quantity": {
      "divide_by": 123
    }
  },
  "end_date": "2023-11-07T05:31:56Z",
  "idempotency_key": "<string>",
  "invoice_description": "<string>",
  "invoice_label": "<string>",
  "metadata": {},
  "overage_price": {
    "amount": "<string>",
    "tiers": [
      {
        "unit_amount": "<string>",
        "flat_amount": "<string>",
        "transform_quantity": {
          "divide_by": 123
        },
        "up_to": 123
      }
    ],
    "transform_quantity": {
      "divide_by": 123
    }
  },
  "priority": 123,
  "subscription_id": "<string>",
  "timezone": "<string>",
  "value": "<string>"
}
'

200

{
  "active_windows": [
    {
      "end": {
        "hour": 12,
        "minute": 29
      },
      "start": {
        "hour": 12,
        "minute": 29
      }
    }
  ],
  "binding": true,
  "collection_method": "per_period",
  "commitment_status": "active",
  "commitment_value": "<string>",
  "committed_price_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": "<string>",
  "currency": "<string>",
  "customer_id": "<string>",
  "end_date": "2023-11-07T05:31:56Z",
  "environment_id": "<string>",
  "id": "<string>",
  "idempotency_key": "<string>",
  "instalment_invoicing": "<string>",
  "invoice_description": "<string>",
  "invoice_label": "<string>",
  "measurement": "billing_period",
  "metadata": {},
  "name": "<string>",
  "on_early_termination": "forfeit",
  "overage_price_id": "<string>",
  "priority": 123,
  "scope_entity_id": "<string>",
  "scope_entity_type": "subscription",
  "start_date": "2023-11-07T05:31:56Z",
  "status": "published",
  "subscription_id": "<string>",
  "tenant_id": "<string>",
  "terminated_at": "2023-11-07T05:31:56Z",
  "termination_invoice_id": "<string>",
  "timezone": "<string>",
  "total_amount": "<string>",
  "type": "amount",
  "updated_at": "2023-11-07T05:31:56Z",
  "updated_by": "<string>",
  "value": "<string>"
}

Authorizations

x-api-key · string · header · required

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

Body

application/json

Commitment

measurement · enum<string> · required

Available options: billing_period, window

name · string · required

Maximum string length: 255

scope · object · required

Show child attributes

start_date · string<date-time> · required

type · enum<string> · required

Available options: amount, quantity

active_windows · object[]

Show child attributes

binding · boolean

default false

collection_method · enum<string>

Available options: per_period, billing_terms

committed_price · object

Show child attributes

end_date · string<date-time>

EndDate is exclusive; omit it for an open-ended commitment, which bills every period until terminated.

idempotency_key · string

Maximum string length: 128

invoice_description · string

Maximum string length: 500

invoice_label · string

Maximum string length: 255

metadata · object

Show child attributes

overage_price · object

Show child attributes

priority · integer

subscription_id · string

SubscriptionID is required on POST /commitments and set server-side on inline commitments.

timezone · string

value · string

Response

200

application/json

OK

active_windows · object[]

Show child attributes

binding · boolean

collection_method · enum<string>

Available options: per_period, billing_terms

commitment_status · enum<string>

Available options: active, ended, terminated

commitment_value · string

committed_price_id · string

created_at · string<date-time>

created_by · string

currency · string

customer_id · string

end_date · string<date-time>

EndDate is exclusive; nil for an open-ended commitment, which runs until terminated.

environment_id · string

id · string

idempotency_key · string

instalment_invoicing · string

invoice_description · string

invoice_label · string

measurement · enum<string>

Available options: billing_period, window

metadata · object

Show child attributes

name · string

on_early_termination · enum<string>

Available options: forfeit, credit_note, bill_remaining

overage_price_id · string

priority · integer

scope_entity_id · string

scope_entity_type · enum<string>

Available options: subscription, group, meter, price

start_date · string<date-time>

status · enum<string>

Available options: published, deleted, archived

subscription_id · string

tenant_id · string

terminated_at · string<date-time>

termination_invoice_id · string

timezone · string

total_amount · string

type · enum<string>

Available options: amount, quantity

updated_at · string<date-time>

updated_by · string

value · string