Skip to navigation

On-demand charges

Charge selected one-off product items on top of an existing subscription whenever you need to: a one-time setup fee, an extra package, or an add-on bought at the click of a button.


Why this matters

Some product items aren’t billed on a recurring schedule; they’re charged when the customer asks for them. Flagging a one-off product item pricing as on-demand (the on_demand flag on its pricing item config) lets you retrieve the on-demand items available for a subscription and charge one or more of them on a separate invoice, with an optional preview first.

Listing the available on-demand items

To know which on-demand items can be charged for a subscription, fetch them per pricing plan schedule with GET /v1/pricing-plan-schedules/{id}/on-demand-pricing-items. Pass the optional timestamp query parameter to evaluate the schedule’s pricing at a specific point in time; it defaults to now.

GET
/v:version/pricing-plan-schedules/:resourceId/on-demand-pricing-items
curl https://test.api.solvimon.com/v1/pricing-plan-schedules//on-demand-pricing-items \
-H "X-API-KEY: <apiKey>"

The response mirrors a pricing plan version, filtered to the product item pricings that are ONE_OFF and flagged on-demand:

Response
{
"pricing_plan_subscription_id": "ppsu_qwDeeN0vxxHy6YCGVV17",
"pricing_plan_schedule_id": "ppsc_vwDeeN0vxxHy8HCJrM1D",
"pricing_plan_version_id": "ppve_FwDeeN0vxxHy66CXdO1e",
"pricing_categories": [
{
"object_type": "PRICING_CATEGORY",
"product_category_id": "proc_YwDeeN0vxxHxVbCEik1P",
"pricings": [
{
"object_type": "PRICING",
"id": "pric_RwDeeN0vxxHyhcCcWV1Y",
"pricing_plan_version_id": "ppve_FwDeeN0vxxHy66CXdO1e",
"name": "Lumen credits top-up",
"product_type": "DEFAULT",
"product_ids": [
"prod_pwDeeN0vxxHytRCRsO1L"
],
"items": [
{
"object_type": "PRICING_ITEM",
"id": "prii_dwDeeN0vxxHy1OCkls19",
"product_item_ids": [
"proi_swDeeN0vxxHytYCXH61H"
],
"configs": [
{
"object_type": "PRICING_ITEM_CONFIG",
"id": "pico_bwDeeN0vxxHyg7CN5m1L",
"details": {
"pricing_type": "FLEXIBLE",
"bands": [
{
"maximum_amount": {
"quantity": "1000.00",
"currency": "EUR"
},
"minimum_amount": {
"quantity": "20.00",
"currency": "EUR"
}
}
]
},
"order": 1,
"on_demand": true,
"wallet_grants": [
{
"wallet_type_id": "wtyp_BwDeeN0vxxHxWOCkua1f",
"credits_grant": {
"conversion": {
"credit_type_id": "ctyp_xwDeeN0vxxHxVWCZif14",
"rate": "100"
}
}
}
]
}
]
}
]
}
],
"display_order": 2
}
]
}

The same endpoint is available in the Customer Portal API, so you can present on-demand items to your customers and let them buy directly from the portal.

Charging an on-demand item

Charge one or more on-demand items with POST /v1/invoices/charge-on-demand-pricing-items:

POST
/v:version/invoices/charge-on-demand-pricing-items
curl -X POST https://test.api.solvimon.com/v1/invoices/charge-on-demand-pricing-items \
-H "X-API-KEY: <apiKey>" \
-H "Content-Type: application/json" \
-d '{
"pricing_plan_schedule_id": "ppsc_vwDeeN0vxxHy8HCJrM1D",
"pricing_items": [
{
"pricing_item_id": "prii_dwDeeN0vxxHy1OCkls19"
}
]
}'
FieldRequiredDescription
pricing_plan_schedule_idyesThe schedule the on-demand items belong to.
pricing_itemsyesThe on-demand items to charge, each referenced by pricing_item_id.
pricing_items[].unitsyes (for FLAT items)The number of units to charge for a one-off item priced FLAT. Must be positive.
start_atnoWhen the charge applies. Must be in the future; defaults to now.
finalize_immediatelynoWhen true, the invoice moves straight from OPEN → DRAFT → FINAL in one call.
payment_method_idnoThe payment method to use. Defaults to the subscription’s payment method.
previewnoWhen true, returns the resulting invoice without persisting it, so you can show the customer what they’ll be charged.

pricing_items accepts the same pricing_item_id more than once. Each occurrence charges its own line and carries its own invoice date, and both lines land in the same invoice group. For example, an item priced at 100 USD granting a fixed 500 credits, listed twice, charges 200 USD and grants 1000 credits.

A one-off item priced FLAT bills a unit price times a count, so the request states the count in units. It is required for such an item and must be positive. There is no fallback to the item’s default_units: that value prefills your ordering screen, while the request states what the customer actually ordered. Ordering zero units is rejected. See One-off pricing.

The response is an invoice containing the charged on-demand lines:

Response
{
"object_type": "string",
"id": "string",
"invoice_number": "string",
"purchase_order_number": "string",
"platform_id": "string",
"customer_id": "string",
"customer_reference": "string",
"sales_tax_percentage": "string",
"customer": {
"object_type": "string",
"id": "string",
"created_at": "string",
"parent_customer_id": "string",
"parent_customer_ids": [
"string"
],
"reference": "string",
"status": "DRAFT",
"timezone": "string",
"type": "ORGANIZATION",
"email": "string",
"notification_preferences": [
{
"type": "INVOICE",
"channels": [
{
"type": "EMAIL",
"enabled": true
}
]
}
],
"locale": "string",
"individual": {
"name": {
"first_name": "string",
"last_name": "string",
"infix": "string"
},
"residential_address": {
"line1": "string",
"line2": "string",
"city": "string",
"postal_code": "string",
"state": "string",
"country": "AD"
}
},
"organization": {
"legal_name": "string",
"tax_id": "string",
"tax_ids": [
{
"id": "string",
"type": "GENERIC_TAX_ID",
"display_name": "string",
"tax_id_validation_result": {
"id": "string",
"validation_date": "string",
"source": "string",
"valid": "VALID",
"message": "string"
}
}
],
"registration_number": "string",
"tax_exempt": true,
"tax_exempt_note": "string",
"registered_address": {
"line1": "string",
"line2": "string",
"city": "string",
"postal_code": "string",
"state": "string",
"country": "AD"
},
"tax_registrations": [
{
"id": "string",
"description": "string",
"tax_id": "string",
"tax_ids": [
{
"id": "string",
"type": "GENERIC_TAX_ID",
"display_name": "string",
"tax_id_validation_result": {
"id": "string",
"validation_date": "string",
"source": "string",
"valid": "VALID",
"message": "string"
}
}
],
"registration_number": "string",
"registered_address": {
"line1": "string",
"line2": "string",
"city": "string",
"postal_code": "string",
"state": "string",
"country": "AD"
}
}
]
},
"custom_fields": [
{
"id": "string",
"reference": "string",
"value": "string",
"values": [
"string"
],
"integration_details": {
"id": "string",
"reference": "string",
"payment_gateway_variant": "ADYEN",
"adyen": {
"recurring_detail_reference": "string"
},
"stripe": {
"payment_method_id": "string"
}
},
"integration_id": "string"
}
],
"pricing_plan_subscription_selector": {
"data": [
{
"field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
"value": "string"
}
],
"rules": [
{
"field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
"type": "EQUALS"
}
],
"filters": [
{
"field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
"type": "EQUALS",
"value": "string"
}
],
"fallback": "LATEST"
},
"linked_integrations": [
{
"id": "string",
"link_details": [
{
"url": "string",
"custom_field_name": "string"
}
]
}
],
"roles": [
"DEFAULT"
],
"seller_details": {
"default_billing_entity_id": "string"
},
"processing_only": true
},
"billing_entity": {
"object_type": "string",
"id": "string",
"created_at": "string",
"reference": "string",
"status": "string",
"timezone": "string",
"legal_name": "string",
"tax_id": "string",
"tax_ids": [
{
"id": "string",
"type": "GENERIC_TAX_ID",
"display_name": "string",
"tax_id_validation_result": {
"id": "string",
"validation_date": "string",
"source": "string",
"valid": "VALID",
"message": "string"
}
}
],
"registration_number": "string",
"registered_address": {
"line1": "string",
"line2": "string",
"city": "string",
"postal_code": "string",
"state": "string",
"country": "AD"
},
"email": "string",
"tax_settings": {
"apply_local_vat_for_missing_tax_id": true
},
"tax_registrations": [
{
"id": "string",
"description": "string",
"tax_id": "string",
"tax_ids": [
{
"id": "string",
"type": "GENERIC_TAX_ID",
"display_name": "string",
"tax_id_validation_result": {
"id": "string",
"validation_date": "string",
"source": "string",
"valid": "VALID",
"message": "string"
}
}
],
"registration_number": "string",
"registered_address": {
"line1": "string",
"line2": "string",
"city": "string",
"postal_code": "string",
"state": "string",
"country": "AD"
}
}
],
"custom_fields": [
{
"id": "string",
"reference": "string",
"value": "string",
"values": [
"string"
],
"integration_details": {
"id": "string",
"reference": "string",
"payment_gateway_variant": "ADYEN",
"adyen": {
"recurring_detail_reference": "string"
},
"stripe": {
"payment_method_id": "string"
}
},
"integration_id": "string"
}
],
"default_customer_country_selector": [
"AD"
],
"default_billing_currency_selector": [
"AED"
],
"linked_integrations": [
{
"id": "string",
"link_details": [
{
"url": "string",
"custom_field_name": "string"
}
]
}
]
},
"status": "string",
"on_hold": true,
"type": "STANDARD",
"created_at": "string",
"updated_at": "string",
"invoice_date": "2024-01-15T09:30:00Z",
"delivery_date": "string",
"due_date": "2024-01-15T09:30:00Z",
"billing_period_date": "string",
"billing_currency": "string",
"invoice_amount_including_tax": {
"quantity": "string",
"currency": "AED"
},
"open_invoice_amount": {
"quantity": "string",
"currency": "AED"
},
"closed_invoice_amount": {
"quantity": "string",
"currency": "AED"
},
"paid_invoice_amount": {
"quantity": "string",
"currency": "AED"
},
"timezone": "string",
"billing_period": {
"type": "DAY",
"value": 1
},
"pricing_plan_subscription_ids": [
"string"
],
"pricing_plan_schedule_ids": [
"string"
],
"pricing_amount_type": "EXCLUDING_TAX",
"periods": [
{
"period_order": 1,
"amount_excluding_tax": {
"quantity": "string",
"currency": "AED"
},
"amount_including_tax": {
"quantity": "string",
"currency": "AED"
},
"billing_period": {
"type": "DAY",
"value": 1
},
"start_at": "string",
"end_at": "string",
"tax_categories": [
{
"base_amount": {
"quantity": "string",
"currency": "AED"
},
"tax_amount": {
"quantity": "string",
"currency": "AED"
},
"total_amount": {
"quantity": "string",
"currency": "AED"
},
"category": "string",
"local_amounts": {
"base_amount": {
"quantity": "string",
"currency": "AED"
},
"tax_amount": {
"quantity": "string",
"currency": "AED"
},
"total_amount": {
"quantity": "string",
"currency": "AED"
},
"used_exchange_rate": {
"currency": "string",
"base_currency": "string",
"rate_timestamp": "string",
"rate": "string",
"source": "string"
},
"display": true
},
"notes": [
"string"
],
"rates": [
{
"name": "string",
"percentage": "string",
"tax_amount": {
"quantity": "string",
"currency": "AED"
}
}
],
"percentage": "string",
"name": "string"
}
],
"groups": [
{
"group_order": 1,
"amount_excluding_tax": {
"quantity": "string",
"currency": "AED"
},
"amount_including_tax": {
"quantity": "string",
"currency": "AED"
},
"billing_period": {
"type": "DAY",
"value": 1
},
"start_at": "string",
"end_at": "string",
"type": "string",
"product_category": {
"object_type": "string",
"id": "string",
"name": "string",
"reference": "string",
"description": "string",
"tax_category": "STANDARD",
"display_order": 1,
"customer_id": "string"
},
"products": [
{
"object_type": "string",
"id": "string",
"category_id": "string",
"category": {
"object_type": "string",
"id": "string",
"name": "string",
"reference": "string",
"description": "string",
"tax_category": "STANDARD",
"display_order": 1,
"customer_id": "string"
},
"parent_product_id": "string",
"name": "string",
"reference": "string",
"description": "string",
"status": "DRAFT",
"product_type": "DEFAULT",
"tax_category": "STANDARD",
"features": [
{
"id": "string",
"reference": "string"
}
],
"custom_fields": [
{
"id": "string",
"reference": "string",
"value": "string",
"values": [
"string"
],
"integration_details": {
"id": "string",
"reference": "string",
"payment_gateway_variant": "ADYEN",
"adyen": {
"recurring_detail_reference": "string"
},
"stripe": {
"payment_method_id": "string"
}
},
"integration_id": "string"
}
],
"display_order": 1,
"linked_integrations": [
{
"id": "string",
"link_details": [
{
"url": "string",
"custom_field_name": "string"
}
]
}
],
"billing_entity_id": "string",
"customer_id": "string",
"agent_context": {
"guidance": "string"
}
}
],
"pricing": {
"id": "string",
"name": "string"
},
"description": "string",
"pricing_plan_subscription_id": "string",
"pricing_plan_schedule_id": "string",
"forwarded_from_customer_id": "string",
"tax_categories": [
{
"base_amount": {
"quantity": "string",
"currency": "AED"
},
"tax_amount": {
"quantity": "string",
"currency": "AED"
},
"total_amount": {
"quantity": "string",
"currency": "AED"
},
"category": "string",
"local_amounts": {
"base_amount": {
"quantity": "string",
"currency": "AED"
},
"tax_amount": {
"quantity": "string",
"currency": "AED"
},
"total_amount": {
"quantity": "string",
"currency": "AED"
},
"used_exchange_rate": {
"currency": "string",
"base_currency": "string",
"rate_timestamp": "string",
"rate": "string",
"source": "string"
},
"display": true
},
"notes": [
"string"
],
"rates": [
{
"name": "string",
"percentage": "string",
"tax_amount": {
"quantity": "string",
"currency": "AED"
}
}
],
"percentage": "string",
"name": "string"
}
],
"lines": [
{
"id": "string",
"line_order": 1,
"description": "string",
"pricing_item_id": "string",
"pricing_item_config_id": "string",
"product_items": [
{
"object_type": "string",
"id": "string",
"product_id": "string",
"product": {
"object_type": "string",
"id": "string",
"category_id": "string",
"category": {
"object_type": "string",
"id": "string",
"name": "string",
"reference": "string",
"description": "string",
"tax_category": "STANDARD",
"display_order": 1,
"customer_id": "string"
},
"parent_product_id": "string",
"name": "string",
"reference": "string",
"description": "string",
"status": "DRAFT",
"product_type": "DEFAULT",
"tax_category": "STANDARD",
"features": [
{
"id": "string",
"reference": "string"
}
],
"custom_fields": [
{
"id": "string",
"reference": "string",
"value": "string",
"values": [
"string"
],
"integration_details": {
"id": "string",
"reference": "string",
"payment_gateway_variant": "ADYEN",
"adyen": {
"recurring_detail_reference": "string"
},
"stripe": {
"payment_method_id": "string"
}
},
"integration_id": "string"
}
],
"display_order": 1,
"linked_integrations": [
{
"id": "string",
"link_details": [
{
"url": "string",
"custom_field_name": "string"
}
]
}
],
"billing_entity_id": "string",
"customer_id": "string",
"agent_context": {
"guidance": "string"
}
},
"name": "string",
"status": "DRAFT",
"reference": "string",
"description": "string",
"type": "REVENUE",
"model_type": "USAGE_BASED",
"usage_based": {
"meter_value_calculation_id": "string",
"meter_value_calculation": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"calculation_type": "SUM",
"persist": true,
"meter_id": "string",
"meter": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"status": "DRAFT",
"meter_values": [
{
"id": "string",
"object": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"status": "DRAFT",
"type": "NUMBER"
},
"required": true
}
],
"meter_properties": [
{
"id": "string",
"object": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"status": "DRAFT",
"type": "NUMBER",
"enum_values": [
"string"
]
},
"required": true
}
]
},
"meter_value_id": "string",
"meter_value": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"status": "DRAFT",
"type": "NUMBER"
},
"meter_property_id": "string",
"meter_property": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"status": "DRAFT",
"type": "NUMBER",
"enum_values": [
"string"
]
}
},
"tiering_meter_value_calculation_id": "string",
"tiering_meter_value_calculation": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"calculation_type": "SUM",
"persist": true,
"meter_id": "string",
"meter": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"status": "DRAFT",
"meter_values": [
{
"id": "string",
"object": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"status": "DRAFT",
"type": "NUMBER"
},
"required": true
}
],
"meter_properties": [
{
"id": "string",
"object": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"status": "DRAFT",
"type": "NUMBER",
"enum_values": [
"string"
]
},
"required": true
}
]
},
"meter_value_id": "string",
"meter_value": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"status": "DRAFT",
"type": "NUMBER"
},
"meter_property_id": "string",
"meter_property": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"status": "DRAFT",
"type": "NUMBER",
"enum_values": [
"string"
]
}
},
"report_meter_value_calculation_ids": [
"string"
],
"conditions": {
"name": "string",
"expression": {
"operator": "AND",
"operands": [
{
"meter_property": {
"id": "string",
"reference": "string",
"meter_property": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"status": "DRAFT",
"type": "NUMBER",
"enum_values": [
"string"
]
},
"value": "string",
"values": [
"string"
],
"meter_property_variable_id": "string",
"meter_property_variable": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"meter_property_id": "string",
"type": "LIST",
"status": "DRAFT",
"value_count": 1,
"created_at": "string",
"updated_at": "string"
},
"comparator": "EQUALS"
},
"expression": {}
}
]
},
"meter_properties": [
{
"id": "string",
"reference": "string",
"meter_property": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"status": "DRAFT",
"type": "NUMBER",
"enum_values": [
"string"
]
},
"value": "string",
"values": [
"string"
],
"meter_property_variable_id": "string",
"meter_property_variable": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"meter_property_id": "string",
"type": "LIST",
"status": "DRAFT",
"value_count": 1,
"created_at": "string",
"updated_at": "string"
},
"comparator": "EQUALS"
}
]
}
},
"credits": {
"credit_type_id": "string",
"credit_type": {
"object_type": "string",
"id": "string",
"reference": "string",
"status": "DRAFT",
"name": "string",
"description": "string",
"unit_name": {
"singular": "string",
"plural": "string"
},
"created_at": "string",
"updated_at": "string"
}
},
"meter_value_calculation": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"calculation_type": "SUM",
"persist": true,
"meter_id": "string",
"meter": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"status": "DRAFT",
"meter_values": [
{
"id": "string",
"object": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"status": "DRAFT",
"type": "NUMBER"
},
"required": true
}
],
"meter_properties": [
{
"id": "string",
"object": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"status": "DRAFT",
"type": "NUMBER",
"enum_values": [
"string"
]
},
"required": true
}
]
},
"meter_value_id": "string",
"meter_value": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"status": "DRAFT",
"type": "NUMBER"
},
"meter_property_id": "string",
"meter_property": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"status": "DRAFT",
"type": "NUMBER",
"enum_values": [
"string"
]
}
},
"tax_category": "STANDARD",
"display_order": 1,
"unit_name": {
"singular": "string",
"plural": "string"
},
"custom_fields": [
{
"id": "string",
"reference": "string",
"value": "string",
"values": [
"string"
],
"integration_details": {
"id": "string",
"reference": "string",
"payment_gateway_variant": "ADYEN",
"adyen": {
"recurring_detail_reference": "string"
},
"stripe": {
"payment_method_id": "string"
}
},
"integration_id": "string"
}
],
"customer_id": "string",
"agent_context": {
"guidance": "string"
},
"meter_value_calculation_id": "string",
"report_meter_value_calculation_ids": [
"string"
]
}
],
"type": "string",
"pricing_type": "string",
"commitment_type": "string",
"discount_type": "string",
"coupon_data": {
"coupon_id": "string",
"promotion_code_id": "string"
},
"tax_categories": [
{
"base_amount": {
"quantity": "string",
"currency": "AED"
},
"tax_amount": {
"quantity": "string",
"currency": "AED"
},
"total_amount": {
"quantity": "string",
"currency": "AED"
},
"category": "string",
"local_amounts": {
"base_amount": {
"quantity": "string",
"currency": "AED"
},
"tax_amount": {
"quantity": "string",
"currency": "AED"
},
"total_amount": {
"quantity": "string",
"currency": "AED"
},
"used_exchange_rate": {
"currency": "string",
"base_currency": "string",
"rate_timestamp": "string",
"rate": "string",
"source": "string"
},
"display": true
},
"notes": [
"string"
],
"rates": [
{
"name": "string",
"percentage": "string",
"tax_amount": {
"quantity": "string",
"currency": "AED"
}
}
],
"percentage": "string",
"name": "string"
}
],
"amount_excluding_tax": {
"quantity": "string",
"currency": "AED"
},
"amount_including_tax": {
"quantity": "string",
"currency": "AED"
},
"conditions": {
"name": "string",
"expression": {
"operator": "AND",
"operands": [
{
"meter_property": {
"id": "string",
"reference": "string",
"meter_property": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"status": "DRAFT",
"type": "NUMBER",
"enum_values": [
"string"
]
},
"value": "string",
"values": [
"string"
],
"meter_property_variable_id": "string",
"meter_property_variable": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"meter_property_id": "string",
"type": "LIST",
"status": "DRAFT",
"value_count": 1,
"created_at": "string",
"updated_at": "string"
},
"comparator": "EQUALS"
},
"expression": {}
}
]
},
"meter_properties": [
{
"id": "string",
"reference": "string",
"meter_property": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"status": "DRAFT",
"type": "NUMBER",
"enum_values": [
"string"
]
},
"value": "string",
"values": [
"string"
],
"meter_property_variable_id": "string",
"meter_property_variable": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"meter_property_id": "string",
"type": "LIST",
"status": "DRAFT",
"value_count": 1,
"created_at": "string",
"updated_at": "string"
},
"comparator": "EQUALS"
}
]
},
"details": {
"amount": {
"quantity": "string",
"currency": "AED"
},
"pricing_currency": "string",
"pricing_amount": {
"quantity": "string",
"currency": "AED"
},
"conversion": {
"credits": {
"quantity": "string",
"credit_type_id": "string",
"credit_type": {
"object_type": "string",
"id": "string",
"reference": "string",
"status": "DRAFT",
"name": "string",
"description": "string",
"unit_name": {
"singular": "string",
"plural": "string"
},
"created_at": "string",
"updated_at": "string"
}
},
"convert_from_meter_value_id": "string"
},
"band": {
"amount": {
"quantity": "string",
"currency": "AED"
},
"percentage": "string",
"credits": {
"quantity": "string",
"credit_type_id": "string",
"credit_type": {
"object_type": "string",
"id": "string",
"reference": "string",
"status": "DRAFT",
"name": "string",
"description": "string",
"unit_name": {
"singular": "string",
"plural": "string"
},
"created_at": "string",
"updated_at": "string"
}
},
"maximum_amount": {
"quantity": "string",
"currency": "AED"
},
"minimum_amount": {
"quantity": "string",
"currency": "AED"
},
"maximum_number": "string",
"minimum_number": "string",
"block_size": {
"number": "string",
"amount": {
"quantity": "string",
"currency": "AED"
},
"count": "string"
},
"tier_lower_bound": {
"number": "string",
"amount": {
"quantity": "string",
"currency": "AED"
},
"count": "string"
},
"tier_top_bound": {
"number": "string",
"amount": {
"quantity": "string",
"currency": "AED"
},
"count": "string"
},
"volume_share": "string",
"included_volume": {
"number": "string",
"amount": {
"quantity": "string",
"currency": "AED"
},
"count": "string"
}
},
"meter_value": {
"id": "string",
"reference": "string",
"number": "string",
"amount": {
"quantity": "string",
"currency": "AED"
},
"count": "string",
"ratio": "string",
"type": "NUMBER"
},
"tiering_meter_value": {
"id": "string",
"reference": "string",
"number": "string",
"amount": {
"quantity": "string",
"currency": "AED"
},
"count": "string",
"ratio": "string",
"type": "NUMBER"
},
"price_bound": "string",
"meter_values": [
{
"number": "string",
"amount": {
"quantity": "string",
"currency": "AED"
},
"amount_in_pricing_currency": {
"quantity": "string",
"currency": "AED"
},
"count": 1,
"ratio": "string"
}
],
"report_meter_values": [
{
"meter_value_calculation_id": "string",
"number": "string",
"amount": {
"quantity": "string",
"currency": "AED"
},
"amount_in_pricing_currency": {
"quantity": "string",
"currency": "AED"
},
"count": "string",
"ratio": "string"
}
],
"description": "string",
"used_exchange_rates": [
{
"currency": "string",
"base_currency": "string",
"rate_timestamp": "string",
"rate": "string",
"source": "string"
}
],
"included_volume_details": {
"included_volume": {
"id": "string",
"reference": "string",
"number": "string",
"amount": {
"quantity": "string",
"currency": "AED"
},
"count": "string",
"ratio": "string",
"type": "NUMBER"
},
"available_included_volume": {
"id": "string",
"reference": "string",
"number": "string",
"amount": {
"quantity": "string",
"currency": "AED"
},
"count": "string",
"ratio": "string",
"type": "NUMBER"
},
"period_volume": {
"id": "string",
"reference": "string",
"number": "string",
"amount": {
"quantity": "string",
"currency": "AED"
},
"count": "string",
"ratio": "string",
"type": "NUMBER"
}
},
"wallet_balances": [
{
"wallet_id": "string",
"used_balance": {
"credits": {
"quantity": "string",
"credit_type_id": "string",
"credit_type": {
"object_type": "string",
"id": "string",
"reference": "string",
"status": "DRAFT",
"name": "string",
"description": "string",
"unit_name": {
"singular": "string",
"plural": "string"
},
"created_at": "string",
"updated_at": "string"
}
},
"amount": {
"quantity": "string",
"currency": "AED"
}
},
"left_balance": {
"credits": {
"quantity": "string",
"credit_type_id": "string",
"credit_type": {
"object_type": "string",
"id": "string",
"reference": "string",
"status": "DRAFT",
"name": "string",
"description": "string",
"unit_name": {
"singular": "string",
"plural": "string"
},
"created_at": "string",
"updated_at": "string"
}
},
"amount": {
"quantity": "string",
"currency": "AED"
}
},
"available_balance": {
"credits": {
"quantity": "string",
"credit_type_id": "string",
"credit_type": {
"object_type": "string",
"id": "string",
"reference": "string",
"status": "DRAFT",
"name": "string",
"description": "string",
"unit_name": {
"singular": "string",
"plural": "string"
},
"created_at": "string",
"updated_at": "string"
}
},
"amount": {
"quantity": "string",
"currency": "AED"
}
}
}
],
"used_wallet_grants": [
{
"wallet_id": "string",
"wallet_grant_id": "string",
"used_balance": {
"credits": {
"quantity": "string",
"credit_type_id": "string",
"credit_type": {
"object_type": "string",
"id": "string",
"reference": "string",
"status": "DRAFT",
"name": "string",
"description": "string",
"unit_name": {
"singular": "string",
"plural": "string"
},
"created_at": "string",
"updated_at": "string"
}
},
"amount": {
"quantity": "string",
"currency": "AED"
}
},
"balance_at": "string",
"paid_at": "string"
}
],
"split_pricing": {
"meter_properties": [
{
"id": "string",
"reference": "string",
"value": "string",
"meter_property": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"status": "DRAFT",
"type": "NUMBER",
"enum_values": [
"string"
]
}
}
]
},
"meter_value_share_of_total": "string",
"meter_value_share_of_processing_only_customer_total": "string",
"wallet_balance_details": {
"used_wallet_credits": {
"quantity": "string",
"credit_type_id": "string",
"credit_type": {
"object_type": "string",
"id": "string",
"reference": "string",
"status": "DRAFT",
"name": "string",
"description": "string",
"unit_name": {
"singular": "string",
"plural": "string"
},
"created_at": "string",
"updated_at": "string"
}
},
"left_wallet_credits": {
"quantity": "string",
"credit_type_id": "string",
"credit_type": {
"object_type": "string",
"id": "string",
"reference": "string",
"status": "DRAFT",
"name": "string",
"description": "string",
"unit_name": {
"singular": "string",
"plural": "string"
},
"created_at": "string",
"updated_at": "string"
}
},
"available_wallet_credits": {
"quantity": "string",
"credit_type_id": "string",
"credit_type": {
"object_type": "string",
"id": "string",
"reference": "string",
"status": "DRAFT",
"name": "string",
"description": "string",
"unit_name": {
"singular": "string",
"plural": "string"
},
"created_at": "string",
"updated_at": "string"
}
}
}
},
"sub_lines": [
{
"sub_line_order": 1,
"details": {
"amount": {
"quantity": "string",
"currency": "AED"
},
"pricing_currency": "string",
"pricing_amount": {
"quantity": "string",
"currency": "AED"
},
"conversion": {
"credits": {
"quantity": "string",
"credit_type_id": "string",
"credit_type": {
"object_type": "string",
"id": "string",
"reference": "string",
"status": "DRAFT",
"name": "string",
"description": "string",
"unit_name": {
"singular": "string",
"plural": "string"
},
"created_at": "string",
"updated_at": "string"
}
},
"convert_from_meter_value_id": "string"
},
"band": {
"amount": {
"quantity": "string",
"currency": "AED"
},
"percentage": "string",
"credits": {
"quantity": "string",
"credit_type_id": "string",
"credit_type": {
"object_type": "string",
"id": "string",
"reference": "string",
"status": "DRAFT",
"name": "string",
"description": "string",
"unit_name": {
"singular": "string",
"plural": "string"
},
"created_at": "string",
"updated_at": "string"
}
},
"maximum_amount": {
"quantity": "string",
"currency": "AED"
},
"minimum_amount": {
"quantity": "string",
"currency": "AED"
},
"maximum_number": "string",
"minimum_number": "string",
"block_size": {
"number": "string",
"amount": {
"quantity": "string",
"currency": "AED"
},
"count": "string"
},
"tier_lower_bound": {
"number": "string",
"amount": {
"quantity": "string",
"currency": "AED"
},
"count": "string"
},
"tier_top_bound": {
"number": "string",
"amount": {
"quantity": "string",
"currency": "AED"
},
"count": "string"
},
"volume_share": "string",
"included_volume": {
"number": "string",
"amount": {
"quantity": "string",
"currency": "AED"
},
"count": "string"
}
},
"meter_value": {
"id": "string",
"reference": "string",
"number": "string",
"amount": {
"quantity": "string",
"currency": "AED"
},
"count": "string",
"ratio": "string",
"type": "NUMBER"
},
"tiering_meter_value": {
"id": "string",
"reference": "string",
"number": "string",
"amount": {
"quantity": "string",
"currency": "AED"
},
"count": "string",
"ratio": "string",
"type": "NUMBER"
},
"price_bound": "string",
"meter_values": [
{
"number": "string",
"amount": {
"quantity": "string",
"currency": "AED"
},
"amount_in_pricing_currency": {
"quantity": "string",
"currency": "AED"
},
"count": 1,
"ratio": "string"
}
],
"report_meter_values": [
{
"meter_value_calculation_id": "string",
"number": "string",
"amount": {
"quantity": "string",
"currency": "AED"
},
"amount_in_pricing_currency": {
"quantity": "string",
"currency": "AED"
},
"count": "string",
"ratio": "string"
}
],
"description": "string",
"used_exchange_rates": [
{
"currency": "string",
"base_currency": "string",
"rate_timestamp": "string",
"rate": "string",
"source": "string"
}
],
"included_volume_details": {
"included_volume": {
"id": "string",
"reference": "string",
"number": "string",
"amount": {
"quantity": "string",
"currency": "AED"
},
"count": "string",
"ratio": "string",
"type": "NUMBER"
},
"available_included_volume": {
"id": "string",
"reference": "string",
"number": "string",
"amount": {
"quantity": "string",
"currency": "AED"
},
"count": "string",
"ratio": "string",
"type": "NUMBER"
},
"period_volume": {
"id": "string",
"reference": "string",
"number": "string",
"amount": {
"quantity": "string",
"currency": "AED"
},
"count": "string",
"ratio": "string",
"type": "NUMBER"
}
},
"wallet_balances": [
{
"wallet_id": "string",
"used_balance": {
"credits": {
"quantity": "string",
"credit_type_id": "string",
"credit_type": {
"object_type": "string",
"id": "string",
"reference": "string",
"status": "DRAFT",
"name": "string",
"description": "string",
"unit_name": {
"singular": "string",
"plural": "string"
},
"created_at": "string",
"updated_at": "string"
}
},
"amount": {
"quantity": "string",
"currency": "AED"
}
},
"left_balance": {
"credits": {
"quantity": "string",
"credit_type_id": "string",
"credit_type": {
"object_type": "string",
"id": "string",
"reference": "string",
"status": "DRAFT",
"name": "string",
"description": "string",
"unit_name": {
"singular": "string",
"plural": "string"
},
"created_at": "string",
"updated_at": "string"
}
},
"amount": {
"quantity": "string",
"currency": "AED"
}
},
"available_balance": {
"credits": {
"quantity": "string",
"credit_type_id": "string",
"credit_type": {
"object_type": "string",
"id": "string",
"reference": "string",
"status": "DRAFT",
"name": "string",
"description": "string",
"unit_name": {
"singular": "string",
"plural": "string"
},
"created_at": "string",
"updated_at": "string"
}
},
"amount": {
"quantity": "string",
"currency": "AED"
}
}
}
],
"used_wallet_grants": [
{
"wallet_id": "string",
"wallet_grant_id": "string",
"used_balance": {
"credits": {
"quantity": "string",
"credit_type_id": "string",
"credit_type": {
"object_type": "string",
"id": "string",
"reference": "string",
"status": "DRAFT",
"name": "string",
"description": "string",
"unit_name": {
"singular": "string",
"plural": "string"
},
"created_at": "string",
"updated_at": "string"
}
},
"amount": {
"quantity": "string",
"currency": "AED"
}
},
"balance_at": "string",
"paid_at": "string"
}
],
"split_pricing": {
"meter_properties": [
{
"id": "string",
"reference": "string",
"value": "string",
"meter_property": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"status": "DRAFT",
"type": "NUMBER",
"enum_values": [
"string"
]
}
}
]
},
"meter_value_share_of_total": "string",
"meter_value_share_of_processing_only_customer_total": "string",
"wallet_balance_details": {
"used_wallet_credits": {
"quantity": "string",
"credit_type_id": "string",
"credit_type": {
"object_type": "string",
"id": "string",
"reference": "string",
"status": "DRAFT",
"name": "string",
"description": "string",
"unit_name": {
"singular": "string",
"plural": "string"
},
"created_at": "string",
"updated_at": "string"
}
},
"left_wallet_credits": {
"quantity": "string",
"credit_type_id": "string",
"credit_type": {
"object_type": "string",
"id": "string",
"reference": "string",
"status": "DRAFT",
"name": "string",
"description": "string",
"unit_name": {
"singular": "string",
"plural": "string"
},
"created_at": "string",
"updated_at": "string"
}
},
"available_wallet_credits": {
"quantity": "string",
"credit_type_id": "string",
"credit_type": {
"object_type": "string",
"id": "string",
"reference": "string",
"status": "DRAFT",
"name": "string",
"description": "string",
"unit_name": {
"singular": "string",
"plural": "string"
},
"created_at": "string",
"updated_at": "string"
}
}
}
},
"description": "string",
"processing_only_customer_id": "string",
"type": "USAGE_BASED_CONVERSION",
"usage_based_conversion": {
"conditions": {
"name": "string",
"expression": {
"operator": "AND",
"operands": [
{
"meter_property": {
"id": "string",
"reference": "string",
"meter_property": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"status": "DRAFT",
"type": "NUMBER",
"enum_values": [
"string"
]
},
"value": "string",
"values": [
"string"
],
"meter_property_variable_id": "string",
"meter_property_variable": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"meter_property_id": "string",
"type": "LIST",
"status": "DRAFT",
"value_count": 1,
"created_at": "string",
"updated_at": "string"
},
"comparator": "EQUALS"
},
"expression": {}
}
]
},
"meter_properties": [
{
"id": "string",
"reference": "string",
"meter_property": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"status": "DRAFT",
"type": "NUMBER",
"enum_values": [
"string"
]
},
"value": "string",
"values": [
"string"
],
"meter_property_variable_id": "string",
"meter_property_variable": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"meter_property_id": "string",
"type": "LIST",
"status": "DRAFT",
"value_count": 1,
"created_at": "string",
"updated_at": "string"
},
"comparator": "EQUALS"
}
]
}
},
"processing_only_customer_resource_id": "string"
}
],
"applicable_for_clauses": [
"string"
],
"meter_value": {
"reference": "string",
"type": "string",
"number": "string",
"amount": {
"quantity": "string",
"currency": "AED"
}
}
}
],
"billing_customer_id": "string"
}
]
}
],
"closed_periods": [
{
"period_order": 1,
"amount_excluding_tax": {
"quantity": "string",
"currency": "AED"
},
"amount_including_tax": {
"quantity": "string",
"currency": "AED"
},
"billing_period": {
"type": "DAY",
"value": 1
},
"start_at": "string",
"end_at": "string",
"tax_categories": [
{
"base_amount": {
"quantity": "string",
"currency": "AED"
},
"tax_amount": {
"quantity": "string",
"currency": "AED"
},
"total_amount": {
"quantity": "string",
"currency": "AED"
},
"category": "string",
"local_amounts": {
"base_amount": {
"quantity": "string",
"currency": "AED"
},
"tax_amount": {
"quantity": "string",
"currency": "AED"
},
"total_amount": {
"quantity": "string",
"currency": "AED"
},
"used_exchange_rate": {
"currency": "string",
"base_currency": "string",
"rate_timestamp": "string",
"rate": "string",
"source": "string"
},
"display": true
},
"notes": [
"string"
],
"rates": [
{
"name": "string",
"percentage": "string",
"tax_amount": {
"quantity": "string",
"currency": "AED"
}
}
],
"percentage": "string",
"name": "string"
}
],
"groups": [
{
"group_order": 1,
"amount_excluding_tax": {
"quantity": "string",
"currency": "AED"
},
"amount_including_tax": {
"quantity": "string",
"currency": "AED"
},
"billing_period": {
"type": "DAY",
"value": 1
},
"start_at": "string",
"end_at": "string",
"type": "string",
"product_category": {
"object_type": "string",
"id": "string",
"name": "string",
"reference": "string",
"description": "string",
"tax_category": "STANDARD",
"display_order": 1,
"customer_id": "string"
},
"products": [
{
"object_type": "string",
"id": "string",
"category_id": "string",
"category": {
"object_type": "string",
"id": "string",
"name": "string",
"reference": "string",
"description": "string",
"tax_category": "STANDARD",
"display_order": 1,
"customer_id": "string"
},
"parent_product_id": "string",
"name": "string",
"reference": "string",
"description": "string",
"status": "DRAFT",
"product_type": "DEFAULT",
"tax_category": "STANDARD",
"features": [
{
"id": "string",
"reference": "string"
}
],
"custom_fields": [
{
"id": "string",
"reference": "string",
"value": "string",
"values": [
"string"
],
"integration_details": {
"id": "string",
"reference": "string",
"payment_gateway_variant": "ADYEN",
"adyen": {
"recurring_detail_reference": "string"
},
"stripe": {
"payment_method_id": "string"
}
},
"integration_id": "string"
}
],
"display_order": 1,
"linked_integrations": [
{
"id": "string",
"link_details": [
{
"url": "string",
"custom_field_name": "string"
}
]
}
],
"billing_entity_id": "string",
"customer_id": "string",
"agent_context": {
"guidance": "string"
}
}
],
"pricing": {
"id": "string",
"name": "string"
},
"description": "string",
"pricing_plan_subscription_id": "string",
"pricing_plan_schedule_id": "string",
"forwarded_from_customer_id": "string",
"tax_categories": [
{
"base_amount": {
"quantity": "string",
"currency": "AED"
},
"tax_amount": {
"quantity": "string",
"currency": "AED"
},
"total_amount": {
"quantity": "string",
"currency": "AED"
},
"category": "string",
"local_amounts": {
"base_amount": {
"quantity": "string",
"currency": "AED"
},
"tax_amount": {
"quantity": "string",
"currency": "AED"
},
"total_amount": {
"quantity": "string",
"currency": "AED"
},
"used_exchange_rate": {
"currency": "string",
"base_currency": "string",
"rate_timestamp": "string",
"rate": "string",
"source": "string"
},
"display": true
},
"notes": [
"string"
],
"rates": [
{
"name": "string",
"percentage": "string",
"tax_amount": {
"quantity": "string",
"currency": "AED"
}
}
],
"percentage": "string",
"name": "string"
}
],
"lines": [
{
"id": "string",
"line_order": 1,
"description": "string",
"pricing_item_id": "string",
"pricing_item_config_id": "string",
"product_items": [
{
"object_type": "string",
"id": "string",
"product_id": "string",
"product": {
"object_type": "string",
"id": "string",
"category_id": "string",
"category": {
"object_type": "string",
"id": "string",
"name": "string",
"reference": "string",
"description": "string",
"tax_category": "STANDARD",
"display_order": 1,
"customer_id": "string"
},
"parent_product_id": "string",
"name": "string",
"reference": "string",
"description": "string",
"status": "DRAFT",
"product_type": "DEFAULT",
"tax_category": "STANDARD",
"features": [
{
"id": "string",
"reference": "string"
}
],
"custom_fields": [
{
"id": "string",
"reference": "string",
"value": "string",
"values": [
"string"
],
"integration_details": {
"id": "string",
"reference": "string",
"payment_gateway_variant": "ADYEN",
"adyen": {
"recurring_detail_reference": "string"
},
"stripe": {
"payment_method_id": "string"
}
},
"integration_id": "string"
}
],
"display_order": 1,
"linked_integrations": [
{
"id": "string",
"link_details": [
{
"url": "string",
"custom_field_name": "string"
}
]
}
],
"billing_entity_id": "string",
"customer_id": "string",
"agent_context": {
"guidance": "string"
}
},
"name": "string",
"status": "DRAFT",
"reference": "string",
"description": "string",
"type": "REVENUE",
"model_type": "USAGE_BASED",
"usage_based": {
"meter_value_calculation_id": "string",
"meter_value_calculation": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"calculation_type": "SUM",
"persist": true,
"meter_id": "string",
"meter": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"status": "DRAFT",
"meter_values": [
{
"id": "string",
"object": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"status": "DRAFT",
"type": "NUMBER"
},
"required": true
}
],
"meter_properties": [
{
"id": "string",
"object": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"status": "DRAFT",
"type": "NUMBER",
"enum_values": [
"string"
]
},
"required": true
}
]
},
"meter_value_id": "string",
"meter_value": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"status": "DRAFT",
"type": "NUMBER"
},
"meter_property_id": "string",
"meter_property": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"status": "DRAFT",
"type": "NUMBER",
"enum_values": [
"string"
]
}
},
"tiering_meter_value_calculation_id": "string",
"tiering_meter_value_calculation": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"calculation_type": "SUM",
"persist": true,
"meter_id": "string",
"meter": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"status": "DRAFT",
"meter_values": [
{
"id": "string",
"object": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"status": "DRAFT",
"type": "NUMBER"
},
"required": true
}
],
"meter_properties": [
{
"id": "string",
"object": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"status": "DRAFT",
"type": "NUMBER",
"enum_values": [
"string"
]
},
"required": true
}
]
},
"meter_value_id": "string",
"meter_value": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"status": "DRAFT",
"type": "NUMBER"
},
"meter_property_id": "string",
"meter_property": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"status": "DRAFT",
"type": "NUMBER",
"enum_values": [
"string"
]
}
},
"report_meter_value_calculation_ids": [
"string"
],
"conditions": {
"name": "string",
"expression": {
"operator": "AND",
"operands": [
{
"meter_property": {
"id": "string",
"reference": "string",
"meter_property": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"status": "DRAFT",
"type": "NUMBER",
"enum_values": [
"string"
]
},
"value": "string",
"values": [
"string"
],
"meter_property_variable_id": "string",
"meter_property_variable": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"meter_property_id": "string",
"type": "LIST",
"status": "DRAFT",
"value_count": 1,
"created_at": "string",
"updated_at": "string"
},
"comparator": "EQUALS"
},
"expression": {}
}
]
},
"meter_properties": [
{
"id": "string",
"reference": "string",
"meter_property": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"status": "DRAFT",
"type": "NUMBER",
"enum_values": [
"string"
]
},
"value": "string",
"values": [
"string"
],
"meter_property_variable_id": "string",
"meter_property_variable": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"meter_property_id": "string",
"type": "LIST",
"status": "DRAFT",
"value_count": 1,
"created_at": "string",
"updated_at": "string"
},
"comparator": "EQUALS"
}
]
}
},
"credits": {
"credit_type_id": "string",
"credit_type": {
"object_type": "string",
"id": "string",
"reference": "string",
"status": "DRAFT",
"name": "string",
"description": "string",
"unit_name": {
"singular": "string",
"plural": "string"
},
"created_at": "string",
"updated_at": "string"
}
},
"meter_value_calculation": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"calculation_type": "SUM",
"persist": true,
"meter_id": "string",
"meter": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"status": "DRAFT",
"meter_values": [
{
"id": "string",
"object": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"status": "DRAFT",
"type": "NUMBER"
},
"required": true
}
],
"meter_properties": [
{
"id": "string",
"object": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"status": "DRAFT",
"type": "NUMBER",
"enum_values": [
"string"
]
},
"required": true
}
]
},
"meter_value_id": "string",
"meter_value": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"status": "DRAFT",
"type": "NUMBER"
},
"meter_property_id": "string",
"meter_property": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"status": "DRAFT",
"type": "NUMBER",
"enum_values": [
"string"
]
}
},
"tax_category": "STANDARD",
"display_order": 1,
"unit_name": {
"singular": "string",
"plural": "string"
},
"custom_fields": [
{
"id": "string",
"reference": "string",
"value": "string",
"values": [
"string"
],
"integration_details": {
"id": "string",
"reference": "string",
"payment_gateway_variant": "ADYEN",
"adyen": {
"recurring_detail_reference": "string"
},
"stripe": {
"payment_method_id": "string"
}
},
"integration_id": "string"
}
],
"customer_id": "string",
"agent_context": {
"guidance": "string"
},
"meter_value_calculation_id": "string",
"report_meter_value_calculation_ids": [
"string"
]
}
],
"type": "string",
"pricing_type": "string",
"commitment_type": "string",
"discount_type": "string",
"coupon_data": {
"coupon_id": "string",
"promotion_code_id": "string"
},
"tax_categories": [
{
"base_amount": {
"quantity": "string",
"currency": "AED"
},
"tax_amount": {
"quantity": "string",
"currency": "AED"
},
"total_amount": {
"quantity": "string",
"currency": "AED"
},
"category": "string",
"local_amounts": {
"base_amount": {
"quantity": "string",
"currency": "AED"
},
"tax_amount": {
"quantity": "string",
"currency": "AED"
},
"total_amount": {
"quantity": "string",
"currency": "AED"
},
"used_exchange_rate": {
"currency": "string",
"base_currency": "string",
"rate_timestamp": "string",
"rate": "string",
"source": "string"
},
"display": true
},
"notes": [
"string"
],
"rates": [
{
"name": "string",
"percentage": "string",
"tax_amount": {
"quantity": "string",
"currency": "AED"
}
}
],
"percentage": "string",
"name": "string"
}
],
"amount_excluding_tax": {
"quantity": "string",
"currency": "AED"
},
"amount_including_tax": {
"quantity": "string",
"currency": "AED"
},
"conditions": {
"name": "string",
"expression": {
"operator": "AND",
"operands": [
{
"meter_property": {
"id": "string",
"reference": "string",
"meter_property": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"status": "DRAFT",
"type": "NUMBER",
"enum_values": [
"string"
]
},
"value": "string",
"values": [
"string"
],
"meter_property_variable_id": "string",
"meter_property_variable": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"meter_property_id": "string",
"type": "LIST",
"status": "DRAFT",
"value_count": 1,
"created_at": "string",
"updated_at": "string"
},
"comparator": "EQUALS"
},
"expression": {}
}
]
},
"meter_properties": [
{
"id": "string",
"reference": "string",
"meter_property": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"status": "DRAFT",
"type": "NUMBER",
"enum_values": [
"string"
]
},
"value": "string",
"values": [
"string"
],
"meter_property_variable_id": "string",
"meter_property_variable": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"meter_property_id": "string",
"type": "LIST",
"status": "DRAFT",
"value_count": 1,
"created_at": "string",
"updated_at": "string"
},
"comparator": "EQUALS"
}
]
},
"details": {
"amount": {
"quantity": "string",
"currency": "AED"
},
"pricing_currency": "string",
"pricing_amount": {
"quantity": "string",
"currency": "AED"
},
"conversion": {
"credits": {
"quantity": "string",
"credit_type_id": "string",
"credit_type": {
"object_type": "string",
"id": "string",
"reference": "string",
"status": "DRAFT",
"name": "string",
"description": "string",
"unit_name": {
"singular": "string",
"plural": "string"
},
"created_at": "string",
"updated_at": "string"
}
},
"convert_from_meter_value_id": "string"
},
"band": {
"amount": {
"quantity": "string",
"currency": "AED"
},
"percentage": "string",
"credits": {
"quantity": "string",
"credit_type_id": "string",
"credit_type": {
"object_type": "string",
"id": "string",
"reference": "string",
"status": "DRAFT",
"name": "string",
"description": "string",
"unit_name": {
"singular": "string",
"plural": "string"
},
"created_at": "string",
"updated_at": "string"
}
},
"maximum_amount": {
"quantity": "string",
"currency": "AED"
},
"minimum_amount": {
"quantity": "string",
"currency": "AED"
},
"maximum_number": "string",
"minimum_number": "string",
"block_size": {
"number": "string",
"amount": {
"quantity": "string",
"currency": "AED"
},
"count": "string"
},
"tier_lower_bound": {
"number": "string",
"amount": {
"quantity": "string",
"currency": "AED"
},
"count": "string"
},
"tier_top_bound": {
"number": "string",
"amount": {
"quantity": "string",
"currency": "AED"
},
"count": "string"
},
"volume_share": "string",
"included_volume": {
"number": "string",
"amount": {
"quantity": "string",
"currency": "AED"
},
"count": "string"
}
},
"meter_value": {
"id": "string",
"reference": "string",
"number": "string",
"amount": {
"quantity": "string",
"currency": "AED"
},
"count": "string",
"ratio": "string",
"type": "NUMBER"
},
"tiering_meter_value": {
"id": "string",
"reference": "string",
"number": "string",
"amount": {
"quantity": "string",
"currency": "AED"
},
"count": "string",
"ratio": "string",
"type": "NUMBER"
},
"price_bound": "string",
"meter_values": [
{
"number": "string",
"amount": {
"quantity": "string",
"currency": "AED"
},
"amount_in_pricing_currency": {
"quantity": "string",
"currency": "AED"
},
"count": 1,
"ratio": "string"
}
],
"report_meter_values": [
{
"meter_value_calculation_id": "string",
"number": "string",
"amount": {
"quantity": "string",
"currency": "AED"
},
"amount_in_pricing_currency": {
"quantity": "string",
"currency": "AED"
},
"count": "string",
"ratio": "string"
}
],
"description": "string",
"used_exchange_rates": [
{
"currency": "string",
"base_currency": "string",
"rate_timestamp": "string",
"rate": "string",
"source": "string"
}
],
"included_volume_details": {
"included_volume": {
"id": "string",
"reference": "string",
"number": "string",
"amount": {
"quantity": "string",
"currency": "AED"
},
"count": "string",
"ratio": "string",
"type": "NUMBER"
},
"available_included_volume": {
"id": "string",
"reference": "string",
"number": "string",
"amount": {
"quantity": "string",
"currency": "AED"
},
"count": "string",
"ratio": "string",
"type": "NUMBER"
},
"period_volume": {
"id": "string",
"reference": "string",
"number": "string",
"amount": {
"quantity": "string",
"currency": "AED"
},
"count": "string",
"ratio": "string",
"type": "NUMBER"
}
},
"wallet_balances": [
{
"wallet_id": "string",
"used_balance": {
"credits": {
"quantity": "string",
"credit_type_id": "string",
"credit_type": {
"object_type": "string",
"id": "string",
"reference": "string",
"status": "DRAFT",
"name": "string",
"description": "string",
"unit_name": {
"singular": "string",
"plural": "string"
},
"created_at": "string",
"updated_at": "string"
}
},
"amount": {
"quantity": "string",
"currency": "AED"
}
},
"left_balance": {
"credits": {
"quantity": "string",
"credit_type_id": "string",
"credit_type": {
"object_type": "string",
"id": "string",
"reference": "string",
"status": "DRAFT",
"name": "string",
"description": "string",
"unit_name": {
"singular": "string",
"plural": "string"
},
"created_at": "string",
"updated_at": "string"
}
},
"amount": {
"quantity": "string",
"currency": "AED"
}
},
"available_balance": {
"credits": {
"quantity": "string",
"credit_type_id": "string",
"credit_type": {
"object_type": "string",
"id": "string",
"reference": "string",
"status": "DRAFT",
"name": "string",
"description": "string",
"unit_name": {
"singular": "string",
"plural": "string"
},
"created_at": "string",
"updated_at": "string"
}
},
"amount": {
"quantity": "string",
"currency": "AED"
}
}
}
],
"used_wallet_grants": [
{
"wallet_id": "string",
"wallet_grant_id": "string",
"used_balance": {
"credits": {
"quantity": "string",
"credit_type_id": "string",
"credit_type": {
"object_type": "string",
"id": "string",
"reference": "string",
"status": "DRAFT",
"name": "string",
"description": "string",
"unit_name": {
"singular": "string",
"plural": "string"
},
"created_at": "string",
"updated_at": "string"
}
},
"amount": {
"quantity": "string",
"currency": "AED"
}
},
"balance_at": "string",
"paid_at": "string"
}
],
"split_pricing": {
"meter_properties": [
{
"id": "string",
"reference": "string",
"value": "string",
"meter_property": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"status": "DRAFT",
"type": "NUMBER",
"enum_values": [
"string"
]
}
}
]
},
"meter_value_share_of_total": "string",
"meter_value_share_of_processing_only_customer_total": "string",
"wallet_balance_details": {
"used_wallet_credits": {
"quantity": "string",
"credit_type_id": "string",
"credit_type": {
"object_type": "string",
"id": "string",
"reference": "string",
"status": "DRAFT",
"name": "string",
"description": "string",
"unit_name": {
"singular": "string",
"plural": "string"
},
"created_at": "string",
"updated_at": "string"
}
},
"left_wallet_credits": {
"quantity": "string",
"credit_type_id": "string",
"credit_type": {
"object_type": "string",
"id": "string",
"reference": "string",
"status": "DRAFT",
"name": "string",
"description": "string",
"unit_name": {
"singular": "string",
"plural": "string"
},
"created_at": "string",
"updated_at": "string"
}
},
"available_wallet_credits": {
"quantity": "string",
"credit_type_id": "string",
"credit_type": {
"object_type": "string",
"id": "string",
"reference": "string",
"status": "DRAFT",
"name": "string",
"description": "string",
"unit_name": {
"singular": "string",
"plural": "string"
},
"created_at": "string",
"updated_at": "string"
}
}
}
},
"sub_lines": [
{
"sub_line_order": 1,
"details": {
"amount": {
"quantity": "string",
"currency": "AED"
},
"pricing_currency": "string",
"pricing_amount": {
"quantity": "string",
"currency": "AED"
},
"conversion": {
"credits": {
"quantity": "string",
"credit_type_id": "string",
"credit_type": {
"object_type": "string",
"id": "string",
"reference": "string",
"status": "DRAFT",
"name": "string",
"description": "string",
"unit_name": {
"singular": "string",
"plural": "string"
},
"created_at": "string",
"updated_at": "string"
}
},
"convert_from_meter_value_id": "string"
},
"band": {
"amount": {
"quantity": "string",
"currency": "AED"
},
"percentage": "string",
"credits": {
"quantity": "string",
"credit_type_id": "string",
"credit_type": {
"object_type": "string",
"id": "string",
"reference": "string",
"status": "DRAFT",
"name": "string",
"description": "string",
"unit_name": {
"singular": "string",
"plural": "string"
},
"created_at": "string",
"updated_at": "string"
}
},
"maximum_amount": {
"quantity": "string",
"currency": "AED"
},
"minimum_amount": {
"quantity": "string",
"currency": "AED"
},
"maximum_number": "string",
"minimum_number": "string",
"block_size": {
"number": "string",
"amount": {
"quantity": "string",
"currency": "AED"
},
"count": "string"
},
"tier_lower_bound": {
"number": "string",
"amount": {
"quantity": "string",
"currency": "AED"
},
"count": "string"
},
"tier_top_bound": {
"number": "string",
"amount": {
"quantity": "string",
"currency": "AED"
},
"count": "string"
},
"volume_share": "string",
"included_volume": {
"number": "string",
"amount": {
"quantity": "string",
"currency": "AED"
},
"count": "string"
}
},
"meter_value": {
"id": "string",
"reference": "string",
"number": "string",
"amount": {
"quantity": "string",
"currency": "AED"
},
"count": "string",
"ratio": "string",
"type": "NUMBER"
},
"tiering_meter_value": {
"id": "string",
"reference": "string",
"number": "string",
"amount": {
"quantity": "string",
"currency": "AED"
},
"count": "string",
"ratio": "string",
"type": "NUMBER"
},
"price_bound": "string",
"meter_values": [
{
"number": "string",
"amount": {
"quantity": "string",
"currency": "AED"
},
"amount_in_pricing_currency": {
"quantity": "string",
"currency": "AED"
},
"count": 1,
"ratio": "string"
}
],
"report_meter_values": [
{
"meter_value_calculation_id": "string",
"number": "string",
"amount": {
"quantity": "string",
"currency": "AED"
},
"amount_in_pricing_currency": {
"quantity": "string",
"currency": "AED"
},
"count": "string",
"ratio": "string"
}
],
"description": "string",
"used_exchange_rates": [
{
"currency": "string",
"base_currency": "string",
"rate_timestamp": "string",
"rate": "string",
"source": "string"
}
],
"included_volume_details": {
"included_volume": {
"id": "string",
"reference": "string",
"number": "string",
"amount": {
"quantity": "string",
"currency": "AED"
},
"count": "string",
"ratio": "string",
"type": "NUMBER"
},
"available_included_volume": {
"id": "string",
"reference": "string",
"number": "string",
"amount": {
"quantity": "string",
"currency": "AED"
},
"count": "string",
"ratio": "string",
"type": "NUMBER"
},
"period_volume": {
"id": "string",
"reference": "string",
"number": "string",
"amount": {
"quantity": "string",
"currency": "AED"
},
"count": "string",
"ratio": "string",
"type": "NUMBER"
}
},
"wallet_balances": [
{
"wallet_id": "string",
"used_balance": {
"credits": {
"quantity": "string",
"credit_type_id": "string",
"credit_type": {
"object_type": "string",
"id": "string",
"reference": "string",
"status": "DRAFT",
"name": "string",
"description": "string",
"unit_name": {
"singular": "string",
"plural": "string"
},
"created_at": "string",
"updated_at": "string"
}
},
"amount": {
"quantity": "string",
"currency": "AED"
}
},
"left_balance": {
"credits": {
"quantity": "string",
"credit_type_id": "string",
"credit_type": {
"object_type": "string",
"id": "string",
"reference": "string",
"status": "DRAFT",
"name": "string",
"description": "string",
"unit_name": {
"singular": "string",
"plural": "string"
},
"created_at": "string",
"updated_at": "string"
}
},
"amount": {
"quantity": "string",
"currency": "AED"
}
},
"available_balance": {
"credits": {
"quantity": "string",
"credit_type_id": "string",
"credit_type": {
"object_type": "string",
"id": "string",
"reference": "string",
"status": "DRAFT",
"name": "string",
"description": "string",
"unit_name": {
"singular": "string",
"plural": "string"
},
"created_at": "string",
"updated_at": "string"
}
},
"amount": {
"quantity": "string",
"currency": "AED"
}
}
}
],
"used_wallet_grants": [
{
"wallet_id": "string",
"wallet_grant_id": "string",
"used_balance": {
"credits": {
"quantity": "string",
"credit_type_id": "string",
"credit_type": {
"object_type": "string",
"id": "string",
"reference": "string",
"status": "DRAFT",
"name": "string",
"description": "string",
"unit_name": {
"singular": "string",
"plural": "string"
},
"created_at": "string",
"updated_at": "string"
}
},
"amount": {
"quantity": "string",
"currency": "AED"
}
},
"balance_at": "string",
"paid_at": "string"
}
],
"split_pricing": {
"meter_properties": [
{
"id": "string",
"reference": "string",
"value": "string",
"meter_property": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"status": "DRAFT",
"type": "NUMBER",
"enum_values": [
"string"
]
}
}
]
},
"meter_value_share_of_total": "string",
"meter_value_share_of_processing_only_customer_total": "string",
"wallet_balance_details": {
"used_wallet_credits": {
"quantity": "string",
"credit_type_id": "string",
"credit_type": {
"object_type": "string",
"id": "string",
"reference": "string",
"status": "DRAFT",
"name": "string",
"description": "string",
"unit_name": {
"singular": "string",
"plural": "string"
},
"created_at": "string",
"updated_at": "string"
}
},
"left_wallet_credits": {
"quantity": "string",
"credit_type_id": "string",
"credit_type": {
"object_type": "string",
"id": "string",
"reference": "string",
"status": "DRAFT",
"name": "string",
"description": "string",
"unit_name": {
"singular": "string",
"plural": "string"
},
"created_at": "string",
"updated_at": "string"
}
},
"available_wallet_credits": {
"quantity": "string",
"credit_type_id": "string",
"credit_type": {
"object_type": "string",
"id": "string",
"reference": "string",
"status": "DRAFT",
"name": "string",
"description": "string",
"unit_name": {
"singular": "string",
"plural": "string"
},
"created_at": "string",
"updated_at": "string"
}
}
}
},
"description": "string",
"processing_only_customer_id": "string",
"type": "USAGE_BASED_CONVERSION",
"usage_based_conversion": {
"conditions": {
"name": "string",
"expression": {
"operator": "AND",
"operands": [
{
"meter_property": {
"id": "string",
"reference": "string",
"meter_property": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"status": "DRAFT",
"type": "NUMBER",
"enum_values": [
"string"
]
},
"value": "string",
"values": [
"string"
],
"meter_property_variable_id": "string",
"meter_property_variable": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"meter_property_id": "string",
"type": "LIST",
"status": "DRAFT",
"value_count": 1,
"created_at": "string",
"updated_at": "string"
},
"comparator": "EQUALS"
},
"expression": {}
}
]
},
"meter_properties": [
{
"id": "string",
"reference": "string",
"meter_property": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"status": "DRAFT",
"type": "NUMBER",
"enum_values": [
"string"
]
},
"value": "string",
"values": [
"string"
],
"meter_property_variable_id": "string",
"meter_property_variable": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"meter_property_id": "string",
"type": "LIST",
"status": "DRAFT",
"value_count": 1,
"created_at": "string",
"updated_at": "string"
},
"comparator": "EQUALS"
}
]
}
},
"processing_only_customer_resource_id": "string"
}
],
"applicable_for_clauses": [
"string"
],
"meter_value": {
"reference": "string",
"type": "string",
"number": "string",
"amount": {
"quantity": "string",
"currency": "AED"
}
}
}
],
"billing_customer_id": "string"
}
]
}
],
"tax_categories": [
{
"base_amount": {
"quantity": "string",
"currency": "AED"
},
"tax_amount": {
"quantity": "string",
"currency": "AED"
},
"total_amount": {
"quantity": "string",
"currency": "AED"
},
"category": "string",
"local_amounts": {
"base_amount": {
"quantity": "string",
"currency": "AED"
},
"tax_amount": {
"quantity": "string",
"currency": "AED"
},
"total_amount": {
"quantity": "string",
"currency": "AED"
},
"used_exchange_rate": {
"currency": "string",
"base_currency": "string",
"rate_timestamp": "string",
"rate": "string",
"source": "string"
},
"display": true
},
"notes": [
"string"
],
"rates": [
{
"name": "string",
"percentage": "string",
"tax_amount": {
"quantity": "string",
"currency": "AED"
}
}
],
"percentage": "string",
"name": "string"
}
],
"tax_summary": {
"base_amount": {
"quantity": "string",
"currency": "AED"
},
"tax_amount": {
"quantity": "string",
"currency": "AED"
},
"total_amount": {
"quantity": "string",
"currency": "AED"
},
"local_amounts": {
"base_amount": {
"quantity": "string",
"currency": "AED"
},
"tax_amount": {
"quantity": "string",
"currency": "AED"
},
"total_amount": {
"quantity": "string",
"currency": "AED"
},
"used_exchange_rate": {
"currency": "string",
"base_currency": "string",
"rate_timestamp": "string",
"rate": "string",
"source": "string"
},
"display": true
},
"notes": [
"string"
],
"country_code": "string"
},
"dunning_actions": [
{
"payment_acceptor_id": "string",
"external_reference": "string",
"status": "CANCEL_PENDING",
"failure_reason": "string",
"first_payment_id": "string"
}
],
"payment_acceptor_ids": [
"string"
],
"payment_actions": [
{
"payment_acceptor_id": "string",
"payment_acceptor": {
"object_type": "string",
"id": "string",
"billing_entity_id": "string",
"customer_id": "string",
"reference": "string",
"name": "string",
"description": "string",
"beneficiary_name": "string",
"type": "BANK_ACCOUNT",
"bank_account": {
"type": "IBAN",
"iban": "string",
"country": "string",
"bic": "string",
"bank_name": "string",
"bank_address": {
"line1": "string",
"line2": "string",
"city": "string",
"postal_code": "string",
"state": "string",
"country": "AD"
},
"account_number_and_bic": {
"account_number": "string",
"bank_code": "string",
"bic": "string"
},
"uk_local": {
"account_number": "string",
"sort_code": "string"
},
"us_local": {
"account_number": "string",
"account_type": "CHECKING",
"bank_code": "string",
"routing_number": "string"
},
"br_local": {
"branch": "string",
"account_number": "string",
"bic": "string"
},
"ar_local": {
"cbu": "string",
"account_number": "string",
"bic": "string"
},
"mx_local": {
"clabe": "string",
"account_number": "string",
"bic": "string"
},
"account_number": "string",
"bank_code": "string",
"routing_number": "string",
"account_type": "CHECKING"
},
"payment_gateway": {
"integration_id": "string",
"integration": {
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"status": "DRAFT",
"message": "string",
"type": "PAYMENT_GATEWAY",
"variant": "DEFAULT",
"paragon_settings": {
"paragon_external_id": "string"
},
"authentication": {
"api_key": {
"header": "string",
"value": "string"
},
"client_credentials": {
"client_id": "string",
"client_secret": "string"
},
"username_password": {
"username": "string",
"password": "string"
}
},
"payment_gateway": {
"variant": "ADYEN",
"adyen": {
"company_account": "string",
"environment": "LIVE",
"live_prefix": "string",
"merchant_accounts": [
"string"
],
"public_key": "string",
"signing_secret": "string",
"ownership": "PLATFORM",
"system_ownership_details": {
"account_holder_id": "string",
"balance_account_id": "string",
"legal_entity_id": "string",
"store_id": "string"
},
"balance_platform_details": {
"account": "string",
"authentication": {
"api_key": {
"header": "string",
"value": "string"
},
"client_credentials": {
"client_id": "string",
"client_secret": "string"
},
"username_password": {
"username": "string",
"password": "string"
}
}
},
"legal_entity_manager_details": {
"authentication": {
"api_key": {
"header": "string",
"value": "string"
},
"client_credentials": {
"client_id": "string",
"client_secret": "string"
},
"username_password": {
"username": "string",
"password": "string"
}
}
},
"enabled_payment_methods": [
"string"
]
},
"stripe": {
"public_key": "string",
"signing_secret": "string"
}
},
"e_invoicing": {
"mandates": [
{
"name": "string",
"country": "string",
"mappings": [
{
"target": "string",
"source": "string",
"description": "string"
}
],
"condition_groups": [
{
"conditions": [
{
"field": "string",
"comparator_type": "EQUALS",
"value": "string"
}
]
}
],
"billing_entity_ids": [
"string"
],
"include_pdf_in_einvoice": true,
"supported_file_formats": [
{
"type": "string",
"description": "string"
}
]
}
],
"processor": "AVALARA"
},
"data_export": {
"variant": "S3",
"s3": {
"bucket_name": "string",
"bucket_path": "string",
"bucket_region": "string",
"authentication_type": "ACCESS_KEY_AND_SECRET",
"role_arn": "string",
"external_id": "string"
},
"bigquery": {
"project_id": "string",
"dataset_id": "string",
"dataset_location": "string",
"gcs_bucket_name": "string",
"gcs_hmac_key_access_id": "string",
"gcs_hmac_key_secret": "string"
},
"gcs": {
"bucket_region": "string",
"bucket_name": "string",
"bucket_path": "string",
"flattening": true
},
"snowflake": {
"host": "string",
"role": "string",
"warehouse": "string",
"database": "string",
"schema": "string"
},
"transport_type": "string"
},
"tax_calculation": {
"billing_entity_id": "string",
"variant": "AVATAX",
"ava_tax": {
"company_code": "string"
},
"custom_tax_codes": [
{
"field": "INVOICE_COMMITMENT",
"value": "string"
}
],
"enable_tax_filing": true
},
"linked_resources_configurations": [
{
"resource_type": "string",
"link_details": [
{
"base_url": "string",
"custom_field_reference": "string"
}
]
}
],
"email_provider": {
"variant": "SYSTEM",
"mailgun": {
"domain": "string",
"region": "US",
"plan": "string"
},
"delivery_window": {
"type": "DAY",
"value": 1
}
},
"erp": {
"variant": "XERO"
}
},
"store_payment_method": true,
"auto_charge_payment_method": true,
"collection_type": "LINK",
"link": {
"expiry_period": {
"type": "DAY",
"value": 1
}
},
"adyen": {
"auto_rescue": {
"enabled": true,
"period": {
"type": "DAY",
"value": 1
}
},
"merchant_account": "string",
"allowed_payment_methods": [
"string"
],
"shopper_statement": "string",
"metadata": [
{
"key": "string",
"value": "string"
}
]
}
},
"custom_redirect": {
"url": "string"
},
"status": "DRAFT"
},
"type": "string",
"bank_account": {
"legal_name": "string",
"country_code": "string",
"iban": "string",
"bic": "string",
"bank_name": "string",
"account_number": "string",
"bank_code": "string",
"sort_code": "string",
"reference": "string",
"routing_number": "string",
"account_type": "string",
"type": "string",
"bank_address": {
"line1": "string",
"line2": "string",
"city": "string",
"postal_code": "string",
"state": "string",
"country": "AD"
},
"branch": "string",
"cbu": "string",
"clabe": "string"
},
"payment_gateway": {
"variant": "string",
"collection_type": "string",
"adyen": {
"id": "string",
"session_data": "string"
},
"stripe": {
"payment_intent_id": "string",
"client_secret": "string"
}
},
"custom_redirect": {
"url": "string"
}
}
],
"pay_invoice_link": {
"expiry_period": {
"type": "MINUTE",
"value": 1
},
"portal_url_id": "string",
"url": "string"
},
"notes": [
"string"
],
"linked_invoices": [
{
"id": "string",
"link_type": "string",
"note": "string",
"invoice_number": "string",
"amount": {
"quantity": "string",
"currency": "AED"
},
"invoice_date": "string"
}
],
"custom_fields": [
{
"id": "string",
"reference": "string",
"value": "string",
"values": [
"string"
],
"integration_details": {
"id": "string",
"reference": "string",
"payment_gateway_variant": "ADYEN",
"adyen": {
"recurring_detail_reference": "string"
},
"stripe": {
"payment_method_id": "string"
}
},
"integration_id": "string"
}
],
"other_custom_fields": [
{
"resource": {
"type": "PLATFORM",
"id": "string"
},
"id": "string",
"reference": "string",
"name": "string",
"value": "string",
"values": [
"string"
]
}
],
"e_invoices": [
{
"external_reference": "string",
"applied_mandate": "string",
"processor": "string",
"status": {
"status": "string",
"timestamp": "string",
"message": "string"
},
"status_history": [
{
"status": "string",
"timestamp": "string",
"message": "string"
}
],
"supported_file_formats": [
{
"type": "string",
"description": "string"
}
],
"workflow_action_execution_id": "string"
}
],
"used_exchange_rates": [
{
"currency": "string",
"base_currency": "string",
"rate_timestamp": "string",
"rate": "string",
"source": "string"
}
],
"processing_only_customers": [
{
"object_type": "string",
"id": "string",
"created_at": "string",
"parent_customer_id": "string",
"parent_customer_ids": [
"string"
],
"reference": "string",
"status": "DRAFT",
"timezone": "string",
"type": "ORGANIZATION",
"email": "string",
"notification_preferences": [
{
"type": "INVOICE",
"channels": [
{
"type": "EMAIL",
"enabled": true
}
]
}
],
"locale": "string",
"individual": {
"name": {
"first_name": "string",
"last_name": "string",
"infix": "string"
},
"residential_address": {
"line1": "string",
"line2": "string",
"city": "string",
"postal_code": "string",
"state": "string",
"country": "AD"
}
},
"organization": {
"legal_name": "string",
"tax_id": "string",
"tax_ids": [
{
"id": "string",
"type": "GENERIC_TAX_ID",
"display_name": "string",
"tax_id_validation_result": {
"id": "string",
"validation_date": "string",
"source": "string",
"valid": "VALID",
"message": "string"
}
}
],
"registration_number": "string",
"tax_exempt": true,
"tax_exempt_note": "string",
"registered_address": {
"line1": "string",
"line2": "string",
"city": "string",
"postal_code": "string",
"state": "string",
"country": "AD"
},
"tax_registrations": [
{
"id": "string",
"description": "string",
"tax_id": "string",
"tax_ids": [
{
"id": "string",
"type": "GENERIC_TAX_ID",
"display_name": "string",
"tax_id_validation_result": {
"id": "string",
"validation_date": "string",
"source": "string",
"valid": "VALID",
"message": "string"
}
}
],
"registration_number": "string",
"registered_address": {
"line1": "string",
"line2": "string",
"city": "string",
"postal_code": "string",
"state": "string",
"country": "AD"
}
}
]
},
"custom_fields": [
{
"id": "string",
"reference": "string",
"value": "string",
"values": [
"string"
],
"integration_details": {
"id": "string",
"reference": "string",
"payment_gateway_variant": "ADYEN",
"adyen": {
"recurring_detail_reference": "string"
},
"stripe": {
"payment_method_id": "string"
}
},
"integration_id": "string"
}
],
"pricing_plan_subscription_selector": {
"data": [
{
"field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
"value": "string"
}
],
"rules": [
{
"field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
"type": "EQUALS"
}
],
"filters": [
{
"field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
"type": "EQUALS",
"value": "string"
}
],
"fallback": "LATEST"
},
"linked_integrations": [
{
"id": "string",
"link_details": [
{
"url": "string",
"custom_field_name": "string"
}
]
}
],
"roles": [
"DEFAULT"
],
"seller_details": {
"default_billing_entity_id": "string"
},
"processing_only": true
}
],
"meter_values": [
{
"object_type": "string",
"id": "string",
"reference": "string",
"name": "string",
"description": "string",
"status": "DRAFT",
"type": "NUMBER"
}
],
"credit_types": [
{
"object_type": "string",
"id": "string",
"reference": "string",
"status": "DRAFT",
"name": "string",
"description": "string",
"unit_name": {
"singular": "string",
"plural": "string"
},
"created_at": "string",
"updated_at": "string"
}
],
"meter_property_variables": [
{
"id": "string",
"reference": "string",
"name": "string",
"type": "LIST"
}
],
"display_invoice_sub_lines_per_processing_only_customer": true,
"show_original_customer_invoice_line": true,
"show_tax_per_line_item": true,
"forwarded_from_customers": [
{
"object_type": "string",
"id": "string",
"created_at": "string",
"parent_customer_id": "string",
"parent_customer_ids": [
"string"
],
"reference": "string",
"status": "DRAFT",
"timezone": "string",
"type": "ORGANIZATION",
"email": "string",
"notification_preferences": [
{
"type": "INVOICE",
"channels": [
{
"type": "EMAIL",
"enabled": true
}
]
}
],
"locale": "string",
"individual": {
"name": {
"first_name": "string",
"last_name": "string",
"infix": "string"
},
"residential_address": {
"line1": "string",
"line2": "string",
"city": "string",
"postal_code": "string",
"state": "string",
"country": "AD"
}
},
"organization": {
"legal_name": "string",
"tax_id": "string",
"tax_ids": [
{
"id": "string",
"type": "GENERIC_TAX_ID",
"display_name": "string",
"tax_id_validation_result": {
"id": "string",
"validation_date": "string",
"source": "string",
"valid": "VALID",
"message": "string"
}
}
],
"registration_number": "string",
"tax_exempt": true,
"tax_exempt_note": "string",
"registered_address": {
"line1": "string",
"line2": "string",
"city": "string",
"postal_code": "string",
"state": "string",
"country": "AD"
},
"tax_registrations": [
{
"id": "string",
"description": "string",
"tax_id": "string",
"tax_ids": [
{
"id": "string",
"type": "GENERIC_TAX_ID",
"display_name": "string",
"tax_id_validation_result": {
"id": "string",
"validation_date": "string",
"source": "string",
"valid": "VALID",
"message": "string"
}
}
],
"registration_number": "string",
"registered_address": {
"line1": "string",
"line2": "string",
"city": "string",
"postal_code": "string",
"state": "string",
"country": "AD"
}
}
]
},
"custom_fields": [
{
"id": "string",
"reference": "string",
"value": "string",
"values": [
"string"
],
"integration_details": {
"id": "string",
"reference": "string",
"payment_gateway_variant": "ADYEN",
"adyen": {
"recurring_detail_reference": "string"
},
"stripe": {
"payment_method_id": "string"
}
},
"integration_id": "string"
}
],
"pricing_plan_subscription_selector": {
"data": [
{
"field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
"value": "string"
}
],
"rules": [
{
"field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
"type": "EQUALS"
}
],
"filters": [
{
"field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY",
"type": "EQUALS",
"value": "string"
}
],
"fallback": "LATEST"
},
"linked_integrations": [
{
"id": "string",
"link_details": [
{
"url": "string",
"custom_field_name": "string"
}
]
}
],
"roles": [
"DEFAULT"
],
"seller_details": {
"default_billing_entity_id": "string"
},
"processing_only": true
}
],
"validation_result": [
{
"status": "string",
"details": "string"
}
],
"reprocess": {
"to_be_reprocessed_at": "string",
"reprocess_status": "string",
"reprocess_id": "string"
},
"used_tax_registration": {
"id": "string",
"description": "string",
"tax_id": "string",
"tax_ids": [
{
"id": "string",
"type": "GENERIC_TAX_ID",
"display_name": "string",
"tax_id_validation_result": {
"id": "string",
"validation_date": "string",
"source": "string",
"valid": "VALID",
"message": "string"
}
}
],
"registration_number": "string",
"registered_address": {
"line1": "string",
"line2": "string",
"city": "string",
"postal_code": "string",
"state": "string",
"country": "AD"
}
},
"footnote": "string",
"approval_status": "PENDING_REVIEW",
"updated_to_final_at": "string",
"has_usage_based_pricing": true,
"coupons": [
{
"coupon_id": "string",
"coupon_name": "string"
}
],
"promotion_codes": [
{
"promotion_code_details": {
"promotion_code_id": "string",
"code": "string"
},
"coupon_id": "string"
}
],
"linked_integrations": [
{
"id": "string",
"link_details": [
{
"url": "string",
"custom_field_name": "string"
}
]
}
],
"billing_type": "DEFAULT",
"payment_status": "UNPAID",
"paid": true,
"auto_rescues": [
{
"payment_acceptor_id": "string",
"external_reference": "string",
"status": "CANCEL_PENDING",
"failure_reason": "string",
"first_payment_id": "string"
}
],
"linked_invoices_ids": [
"string"
],
"credit": {
"original_invoice_info": {
"id": "string",
"invoice_number": "string"
},
"note": "string",
"credit_details_source": "CURRENT",
"original_invoice_id": "string"
},
"to_be_reprocessed": true,
"to_be_reprocessed_at": "string"
}

Use preview: true to show the customer what the charge will look like before they confirm. A preview is never persisted and never finalized, regardless of finalize_immediately.

Typical flow

1

List the available items

Call GET /v1/pricing-plan-schedules/{id}/on-demand-pricing-items and show the available items to the customer.

2

Let the customer pick

The customer selects one or more items to buy.

3

Preview the charge (optional)

Call the charge endpoint with preview: true to show the expected invoice before the customer confirms.

4

Create the invoice

Call the charge endpoint with preview: false to create the invoice, optionally with finalize_immediately: true to finalize it in the same call.


See also: Wallet top-ups, which uses on-demand items to sell credits, One-off pricing, Add-ons, Invoices and One-off invoices.