Dunning & payment retries
Dunning & payment retries
This guide talks about ahat Solvimon does when an invoice is not paid: how payment attempts are retried, what dunning actions look like on the invoice, and how to drive reminders and escalation from workflows.
Why this matters
A failed payment is not an exception; on a card-based subscription book it is a steady percentage of every billing run. Dunning is the process that turns those failures back into cash: retry the payment, remind the customer, and escalate when the reminders do not work. Solvimon tracks the attempts and exposes the triggers; the retry cadence itself lives with your payment service provider.
How it works
Two separate mechanisms operate on an unpaid invoice.
Payment retries are attempts to charge the stored payment method again. For card payments through Adyen, this is Adyen Auto Rescue, which decides which refused or charged-back payments are worth retrying and picks the timing. Solvimon records each attempt.
Dunning actions are the collection steps Solvimon itself takes against an invoice: the payment requests it raises and their outcome. Each carries a status:
| Status | Meaning |
|---|---|
PENDING | The dunning action has been raised and is awaiting an outcome |
SUCCESSFUL | The payment was collected |
FAILED | The attempt failed; failure_reason carries the detail |
CANCEL_PENDING | A cancellation has been requested and is being processed |
CANCELLED | The dunning action was cancelled before completion |
A dunning action references the payment_acceptor_id it was raised against and the first_payment_id of the attempt chain, so a sequence of retries on one invoice stays traceable to a single collection effort.
Retry counts and intervals are configured at the payment service provider, not in Solvimon. Solvimon exposes the resulting attempts (attempt, and whether a next_attempt_scheduled exists) but has no retry-schedule setting of its own.
Inspecting attempts
To see what has been tried on an invoice, read its payment attempts:
curl https://api.solvimon.com/v1/invoices//payment-attempts \-H "X-API-KEY: <apiKey>"
Response
{"data": [{"object_type": "string","id": "string","created_at": "string","timestamp": "2024-01-15T09:30:00Z","customer_id": "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},"invoice_id": "string","payment_acceptor_id": "string","payment_acceptor_reference": "string","payment_method_id": "string","payment_method_details": {"type": "CARD","card": {"brand": "string","name": "string","expiry_date": {"expiry_month": 1,"expiry_year": 1},"last_four_digits": "string","country": "string"},"online_banking": {"variant": "string","owner_name": "string","iban": "string","bic": "string","country": "AD"},"buy_now_pay_later": {"variant": "string"},"direct_debit": {"variant": "string","owner_name": "string","iban": "string","bic": "string","country": "AD"},"digital_wallet": {"variant": "string"},"unknown": {"variant": "string"}},"integration_payment_method_reference": "string","external_reference": "string","reference": "string","amount": {"quantity": "string","currency": "AED"},"result": "AUTHORIZED","result_details": {"code": "string","reason": "string","external_code": "string","external_reason": "string"},"dunning_action_details": {"attempt": 1,"external_reference": "string","next_attempt_scheduled": true},"updated_at": "string","context": {"type": "INVOICE","related_resource_ids": [{"type": "PLATFORM","id": "string"}],"metadata": {},"init_pricing_plan_subscription": {"template_pricing_plan_subscription_id": "string","pricing_plan_subscription_id": "string","billing_entity_id": "string","customer_details": {"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},"pricing_plan_schedule_customizations": [{"pricing_plan_schedule_id": "string","seats_values": [{"pricing_item_config_id": "string","number": "string","amount": {"quantity": "string","currency": "AED"},"start_at": "2024-01-15T09:30:00Z","end_at": "string"}],"enabled_pricings": [{"pricing_id": "string","start_at": "2024-01-15T09:30:00Z","end_at": "2024-01-15T09:30:00Z"}],"promotion_codes": ["string"],"pricing_currency": "AED","billing_period": {"type": "DAY","value": 1}}],"enabled_pricings": [{"pricing_id": "string","start_at": "2024-01-15T09:30:00Z","end_at": "2024-01-15T09:30:00Z"}]},"create_payment_method": {"payment_method_id": "string"},"payment_request": {"payment_request_id": "string"},"pay_invoice": {"invoice_id": "string"},"charge_on_demand": {"pricing_plan_schedule_id": "string","pricing_items": [{"pricing_item_id": "string"}],"start_at": "2024-01-15T09:30:00Z"},"direct": {"adyen": {"capture_delay_hours": 1,"auto_rescue": {"enabled": true,"period": {"type": "DAY","value": 1}}}},"create_pricing_plan_schedule": {"pricing_plan_subscription_id": "string","pricing_plan_version_id": "string","pricing_id": "string","start_at": "2024-01-15T09:30:00Z"}}}],"page": 1,"limit": 1,"links": {"first": "string","previous": "string","current": "string","next": "string"},"total_number_of_pages": 1}
Each attempt carries the attempt number, an external_reference to the attempt at the provider, and next_attempt_scheduled, which tells you whether the provider intends to try again. When next_attempt_scheduled is false and the result is still unpaid, the automated retry chain is finished and the invoice needs human collection.
Payment results use a fixed set of values: AUTHORIZED, PENDING, REFUSED, CANCELLED, ERROR, REFUNDED, and CHARGED_BACK. result_details carries the provider’s reason, which is what you surface to the customer or to your collections team.
To see the payments themselves rather than the attempt chain, use GET /v{version}/invoices/{resourceId}/payments.
Stopping dunning on an invoice
When an invoice should no longer be chased, for example because it is disputed or is being settled by bank transfer, cancel its outstanding dunning actions:
curl -X POST https://api.solvimon.com/v1/invoices//cancel-dunning-actions \-H "X-API-KEY: <apiKey>"
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"}],"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"},"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"],"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"],"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","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"],"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"],"comparator": "EQUALS"}]},"meter_value": {"reference": "string","type": "string","number": "string","amount": {"quantity": "string","currency": "AED"}},"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_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"}}},"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"},"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_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"}}},"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"},"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"],"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"],"comparator": "EQUALS"}]}},"processing_only_customer_resource_id": "string"}]}],"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"}],"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"},"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"],"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"],"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","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"],"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"],"comparator": "EQUALS"}]},"meter_value": {"reference": "string","type": "string","number": "string","amount": {"quantity": "string","currency": "AED"}},"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_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"}}},"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"},"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_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"}}},"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"},"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"],"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"],"comparator": "EQUALS"}]}},"processing_only_customer_resource_id": "string"}]}],"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","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"}]}],"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"]}},"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": "DAY","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"]}],"credit": {"original_invoice_info": {"id": "string","invoice_number": "string"},"note": "string","credit_details_source": "CURRENT","original_invoice_id": "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"}]}],"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"}],"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"],"to_be_reprocessed": true,"to_be_reprocessed_at": "string"}
Actions move to CANCEL_PENDING and then CANCELLED. Cancelling dunning does not change the invoice’s payment_status; the invoice stays unpaid until a payment is recorded or it is marked paid.
Cancelling a subscription can also cancel its dunning actions as part of the cancellation. See Subscription lifecycle.
A pending auto rescue is also cancelled automatically when the invoice is settled another way. If a payment was refused for insufficient funds, Solvimon schedules an automatic rescue with the payment provider; if the platform then pays the invoice directly through POST /v1/invoices/{id}/pay, that pending rescue is cancelled rather than firing later and charging the customer a second time. A second auto rescue is not started for an invoice that already has one active.
A call to the payment provider can itself fail with a rate-limit response (429) during a burst of payments, separately from the payment being refused. Solvimon retries a 429 with exponential backoff and jitter instead of failing the payment action, so a rate limit does not raise an alert or mark the action ERROR.
Reminders and escalation with workflows
Solvimon has no fixed dunning ladder. You build the reminder and escalation sequence with workflows, which gives you control over timing, channel, and wording per billing entity or customer segment.
The two triggers that matter:
- Failed payment. Fires when a payment attempt fails, so you can email the customer to update their payment method, notify an account owner, or open a task in your CRM.
- Overdue invoice. Fires on invoices past their due date, on the schedule you set, which is how you build the reminder ladder (for example at 3, 14, and 30 days overdue).
See Common use cases for a worked overdue-reminder sequence.
Recurring collection with payment schedules
For instalment plans and recurring collection outside the invoice cycle, a payment schedule collects on its own cadence. A schedule has a type of ONE_OFF, RECURRING, or INSTALLMENTS, and a status of ACTIVE, PAUSED, CANCELLED, or DONE.
Two fields matter for collections:
payment_method_fallbacknames the method to try when the primary method fails, so a failed card can fall back to direct debit without manual intervention.- Dunning can be enabled or disabled per schedule, so an instalment plan can be exempted from the standard chase.
Pause a schedule with POST /v{version}/payment-schedules/{resourceIdOrReference}/pause while a dispute is open, and activate it again afterwards, rather than cancelling and rebuilding it.
Edge cases
- Chargebacks are not failed payments. A
CHARGED_BACKpayment was collected and then reversed. It does not re-enter the retry chain; handle it as a dispute. - Partial payments leave the invoice
PARTIALLY_PAID. Dunning continues against the remaining balance. - Overpayments leave the invoice
OVERPAIDrather than creating a credit automatically. - Manual bank transfers arrive outside the PSP, so mark the invoice paid to stop the chase. See Payment collections.