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:
1 curl https://api.solvimon.com/v1/invoices//payment-attempts \ 2 -H "X-API-KEY: <apiKey>"
Response
1 { 2 "data": [ 3 { 4 "object_type": "string", 5 "id": "string", 6 "created_at": "string", 7 "timestamp": "2024-01-15T09:30:00Z", 8 "customer_id": "string", 9 "customer": { 10 "object_type": "string", 11 "id": "string", 12 "created_at": "string", 13 "parent_customer_id": "string", 14 "parent_customer_ids": [ 15 "string" 16 ], 17 "reference": "string", 18 "status": "DRAFT", 19 "timezone": "string", 20 "type": "ORGANIZATION", 21 "email": "string", 22 "notification_preferences": [ 23 { 24 "type": "INVOICE", 25 "channels": [ 26 { 27 "type": "EMAIL", 28 "enabled": true 29 } 30 ] 31 } 32 ], 33 "locale": "string", 34 "individual": { 35 "name": { 36 "first_name": "string", 37 "last_name": "string", 38 "infix": "string" 39 }, 40 "residential_address": { 41 "line1": "string", 42 "line2": "string", 43 "city": "string", 44 "postal_code": "string", 45 "state": "string", 46 "country": "AD" 47 } 48 }, 49 "organization": { 50 "legal_name": "string", 51 "tax_id": "string", 52 "tax_ids": [ 53 { 54 "id": "string", 55 "type": "GENERIC_TAX_ID", 56 "display_name": "string", 57 "tax_id_validation_result": { 58 "id": "string", 59 "validation_date": "string", 60 "source": "string", 61 "valid": "VALID", 62 "message": "string" 63 } 64 } 65 ], 66 "registration_number": "string", 67 "tax_exempt": true, 68 "tax_exempt_note": "string", 69 "registered_address": { 70 "line1": "string", 71 "line2": "string", 72 "city": "string", 73 "postal_code": "string", 74 "state": "string", 75 "country": "AD" 76 }, 77 "tax_registrations": [ 78 { 79 "id": "string", 80 "description": "string", 81 "tax_id": "string", 82 "tax_ids": [ 83 { 84 "id": "string", 85 "type": "GENERIC_TAX_ID", 86 "display_name": "string", 87 "tax_id_validation_result": { 88 "id": "string", 89 "validation_date": "string", 90 "source": "string", 91 "valid": "VALID", 92 "message": "string" 93 } 94 } 95 ], 96 "registration_number": "string", 97 "registered_address": { 98 "line1": "string", 99 "line2": "string", 100 "city": "string", 101 "postal_code": "string", 102 "state": "string", 103 "country": "AD" 104 } 105 } 106 ] 107 }, 108 "custom_fields": [ 109 { 110 "id": "string", 111 "reference": "string", 112 "value": "string", 113 "values": [ 114 "string" 115 ], 116 "integration_details": { 117 "id": "string", 118 "reference": "string", 119 "payment_gateway_variant": "ADYEN", 120 "adyen": { 121 "recurring_detail_reference": "string" 122 }, 123 "stripe": { 124 "payment_method_id": "string" 125 } 126 }, 127 "integration_id": "string" 128 } 129 ], 130 "pricing_plan_subscription_selector": { 131 "data": [ 132 { 133 "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY", 134 "value": "string" 135 } 136 ], 137 "rules": [ 138 { 139 "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY", 140 "type": "EQUALS" 141 } 142 ], 143 "filters": [ 144 { 145 "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY", 146 "type": "EQUALS", 147 "value": "string" 148 } 149 ], 150 "fallback": "LATEST" 151 }, 152 "linked_integrations": [ 153 { 154 "id": "string", 155 "link_details": [ 156 { 157 "url": "string", 158 "custom_field_name": "string" 159 } 160 ] 161 } 162 ], 163 "roles": [ 164 "DEFAULT" 165 ], 166 "seller_details": { 167 "default_billing_entity_id": "string" 168 }, 169 "processing_only": true 170 }, 171 "invoice_id": "string", 172 "payment_acceptor_id": "string", 173 "payment_acceptor_reference": "string", 174 "payment_method_id": "string", 175 "payment_method_details": { 176 "type": "CARD", 177 "card": { 178 "brand": "string", 179 "name": "string", 180 "expiry_date": { 181 "expiry_month": 1, 182 "expiry_year": 1 183 }, 184 "last_four_digits": "string", 185 "country": "string" 186 }, 187 "online_banking": { 188 "variant": "string", 189 "owner_name": "string", 190 "iban": "string", 191 "bic": "string", 192 "country": "AD" 193 }, 194 "buy_now_pay_later": { 195 "variant": "string" 196 }, 197 "direct_debit": { 198 "variant": "string", 199 "owner_name": "string", 200 "iban": "string", 201 "bic": "string", 202 "country": "AD" 203 }, 204 "digital_wallet": { 205 "variant": "string" 206 }, 207 "unknown": { 208 "variant": "string" 209 } 210 }, 211 "integration_payment_method_reference": "string", 212 "external_reference": "string", 213 "reference": "string", 214 "amount": { 215 "quantity": "string", 216 "currency": "AED" 217 }, 218 "result": "AUTHORIZED", 219 "result_details": { 220 "code": "string", 221 "reason": "string", 222 "external_code": "string", 223 "external_reason": "string" 224 }, 225 "dunning_action_details": { 226 "attempt": 1, 227 "external_reference": "string", 228 "next_attempt_scheduled": true 229 }, 230 "updated_at": "string", 231 "context": { 232 "type": "INVOICE", 233 "related_resource_ids": [ 234 { 235 "type": "PLATFORM", 236 "id": "string" 237 } 238 ], 239 "metadata": {}, 240 "init_pricing_plan_subscription": { 241 "template_pricing_plan_subscription_id": "string", 242 "pricing_plan_subscription_id": "string", 243 "billing_entity_id": "string", 244 "customer_details": { 245 "object_type": "string", 246 "id": "string", 247 "created_at": "string", 248 "parent_customer_id": "string", 249 "parent_customer_ids": [ 250 "string" 251 ], 252 "reference": "string", 253 "status": "DRAFT", 254 "timezone": "string", 255 "type": "ORGANIZATION", 256 "email": "string", 257 "notification_preferences": [ 258 { 259 "type": "INVOICE", 260 "channels": [ 261 { 262 "type": "EMAIL", 263 "enabled": true 264 } 265 ] 266 } 267 ], 268 "locale": "string", 269 "individual": { 270 "name": { 271 "first_name": "string", 272 "last_name": "string", 273 "infix": "string" 274 }, 275 "residential_address": { 276 "line1": "string", 277 "line2": "string", 278 "city": "string", 279 "postal_code": "string", 280 "state": "string", 281 "country": "AD" 282 } 283 }, 284 "organization": { 285 "legal_name": "string", 286 "tax_id": "string", 287 "tax_ids": [ 288 { 289 "id": "string", 290 "type": "GENERIC_TAX_ID", 291 "display_name": "string", 292 "tax_id_validation_result": { 293 "id": "string", 294 "validation_date": "string", 295 "source": "string", 296 "valid": "VALID", 297 "message": "string" 298 } 299 } 300 ], 301 "registration_number": "string", 302 "tax_exempt": true, 303 "tax_exempt_note": "string", 304 "registered_address": { 305 "line1": "string", 306 "line2": "string", 307 "city": "string", 308 "postal_code": "string", 309 "state": "string", 310 "country": "AD" 311 }, 312 "tax_registrations": [ 313 { 314 "id": "string", 315 "description": "string", 316 "tax_id": "string", 317 "tax_ids": [ 318 { 319 "id": "string", 320 "type": "GENERIC_TAX_ID", 321 "display_name": "string", 322 "tax_id_validation_result": { 323 "id": "string", 324 "validation_date": "string", 325 "source": "string", 326 "valid": "VALID", 327 "message": "string" 328 } 329 } 330 ], 331 "registration_number": "string", 332 "registered_address": { 333 "line1": "string", 334 "line2": "string", 335 "city": "string", 336 "postal_code": "string", 337 "state": "string", 338 "country": "AD" 339 } 340 } 341 ] 342 }, 343 "custom_fields": [ 344 { 345 "id": "string", 346 "reference": "string", 347 "value": "string", 348 "values": [ 349 "string" 350 ], 351 "integration_details": { 352 "id": "string", 353 "reference": "string", 354 "payment_gateway_variant": "ADYEN", 355 "adyen": { 356 "recurring_detail_reference": "string" 357 }, 358 "stripe": { 359 "payment_method_id": "string" 360 } 361 }, 362 "integration_id": "string" 363 } 364 ], 365 "pricing_plan_subscription_selector": { 366 "data": [ 367 { 368 "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY", 369 "value": "string" 370 } 371 ], 372 "rules": [ 373 { 374 "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY", 375 "type": "EQUALS" 376 } 377 ], 378 "filters": [ 379 { 380 "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY", 381 "type": "EQUALS", 382 "value": "string" 383 } 384 ], 385 "fallback": "LATEST" 386 }, 387 "linked_integrations": [ 388 { 389 "id": "string", 390 "link_details": [ 391 { 392 "url": "string", 393 "custom_field_name": "string" 394 } 395 ] 396 } 397 ], 398 "roles": [ 399 "DEFAULT" 400 ], 401 "seller_details": { 402 "default_billing_entity_id": "string" 403 }, 404 "processing_only": true 405 }, 406 "pricing_plan_schedule_customizations": [ 407 { 408 "pricing_plan_schedule_id": "string", 409 "seats_values": [ 410 { 411 "pricing_item_config_id": "string", 412 "number": "string", 413 "amount": { 414 "quantity": "string", 415 "currency": "AED" 416 }, 417 "start_at": "2024-01-15T09:30:00Z", 418 "end_at": "string" 419 } 420 ], 421 "enabled_pricings": [ 422 { 423 "pricing_id": "string", 424 "start_at": "2024-01-15T09:30:00Z", 425 "end_at": "2024-01-15T09:30:00Z" 426 } 427 ], 428 "promotion_codes": [ 429 "string" 430 ], 431 "pricing_currency": "AED", 432 "billing_period": { 433 "type": "DAY", 434 "value": 1 435 } 436 } 437 ], 438 "enabled_pricings": [ 439 { 440 "pricing_id": "string", 441 "start_at": "2024-01-15T09:30:00Z", 442 "end_at": "2024-01-15T09:30:00Z" 443 } 444 ] 445 }, 446 "create_payment_method": { 447 "payment_method_id": "string" 448 }, 449 "payment_request": { 450 "payment_request_id": "string" 451 }, 452 "pay_invoice": { 453 "invoice_id": "string" 454 }, 455 "charge_on_demand": { 456 "pricing_plan_schedule_id": "string", 457 "pricing_items": [ 458 { 459 "pricing_item_id": "string" 460 } 461 ], 462 "start_at": "2024-01-15T09:30:00Z" 463 }, 464 "direct": { 465 "adyen": { 466 "capture_delay_hours": 1, 467 "auto_rescue": { 468 "enabled": true, 469 "period": { 470 "type": "DAY", 471 "value": 1 472 } 473 } 474 } 475 }, 476 "create_pricing_plan_schedule": { 477 "pricing_plan_subscription_id": "string", 478 "pricing_plan_version_id": "string", 479 "pricing_id": "string", 480 "start_at": "2024-01-15T09:30:00Z" 481 } 482 } 483 } 484 ], 485 "page": 1, 486 "limit": 1, 487 "links": { 488 "first": "string", 489 "previous": "string", 490 "current": "string", 491 "next": "string" 492 }, 493 "total_number_of_pages": 1 494 }
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:
1 curl -X POST https://api.solvimon.com/v1/invoices//cancel-dunning-actions \ 2 -H "X-API-KEY: <apiKey>"
Response
1 { 2 "object_type": "string", 3 "id": "string", 4 "invoice_number": "string", 5 "purchase_order_number": "string", 6 "platform_id": "string", 7 "customer_id": "string", 8 "customer_reference": "string", 9 "sales_tax_percentage": "string", 10 "customer": { 11 "object_type": "string", 12 "id": "string", 13 "created_at": "string", 14 "parent_customer_id": "string", 15 "parent_customer_ids": [ 16 "string" 17 ], 18 "reference": "string", 19 "status": "DRAFT", 20 "timezone": "string", 21 "type": "ORGANIZATION", 22 "email": "string", 23 "notification_preferences": [ 24 { 25 "type": "INVOICE", 26 "channels": [ 27 { 28 "type": "EMAIL", 29 "enabled": true 30 } 31 ] 32 } 33 ], 34 "locale": "string", 35 "individual": { 36 "name": { 37 "first_name": "string", 38 "last_name": "string", 39 "infix": "string" 40 }, 41 "residential_address": { 42 "line1": "string", 43 "line2": "string", 44 "city": "string", 45 "postal_code": "string", 46 "state": "string", 47 "country": "AD" 48 } 49 }, 50 "organization": { 51 "legal_name": "string", 52 "tax_id": "string", 53 "tax_ids": [ 54 { 55 "id": "string", 56 "type": "GENERIC_TAX_ID", 57 "display_name": "string", 58 "tax_id_validation_result": { 59 "id": "string", 60 "validation_date": "string", 61 "source": "string", 62 "valid": "VALID", 63 "message": "string" 64 } 65 } 66 ], 67 "registration_number": "string", 68 "tax_exempt": true, 69 "tax_exempt_note": "string", 70 "registered_address": { 71 "line1": "string", 72 "line2": "string", 73 "city": "string", 74 "postal_code": "string", 75 "state": "string", 76 "country": "AD" 77 }, 78 "tax_registrations": [ 79 { 80 "id": "string", 81 "description": "string", 82 "tax_id": "string", 83 "tax_ids": [ 84 { 85 "id": "string", 86 "type": "GENERIC_TAX_ID", 87 "display_name": "string", 88 "tax_id_validation_result": { 89 "id": "string", 90 "validation_date": "string", 91 "source": "string", 92 "valid": "VALID", 93 "message": "string" 94 } 95 } 96 ], 97 "registration_number": "string", 98 "registered_address": { 99 "line1": "string", 100 "line2": "string", 101 "city": "string", 102 "postal_code": "string", 103 "state": "string", 104 "country": "AD" 105 } 106 } 107 ] 108 }, 109 "custom_fields": [ 110 { 111 "id": "string", 112 "reference": "string", 113 "value": "string", 114 "values": [ 115 "string" 116 ], 117 "integration_details": { 118 "id": "string", 119 "reference": "string", 120 "payment_gateway_variant": "ADYEN", 121 "adyen": { 122 "recurring_detail_reference": "string" 123 }, 124 "stripe": { 125 "payment_method_id": "string" 126 } 127 }, 128 "integration_id": "string" 129 } 130 ], 131 "pricing_plan_subscription_selector": { 132 "data": [ 133 { 134 "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY", 135 "value": "string" 136 } 137 ], 138 "rules": [ 139 { 140 "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY", 141 "type": "EQUALS" 142 } 143 ], 144 "filters": [ 145 { 146 "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY", 147 "type": "EQUALS", 148 "value": "string" 149 } 150 ], 151 "fallback": "LATEST" 152 }, 153 "linked_integrations": [ 154 { 155 "id": "string", 156 "link_details": [ 157 { 158 "url": "string", 159 "custom_field_name": "string" 160 } 161 ] 162 } 163 ], 164 "roles": [ 165 "DEFAULT" 166 ], 167 "seller_details": { 168 "default_billing_entity_id": "string" 169 }, 170 "processing_only": true 171 }, 172 "billing_entity": { 173 "object_type": "string", 174 "id": "string", 175 "created_at": "string", 176 "reference": "string", 177 "status": "string", 178 "timezone": "string", 179 "legal_name": "string", 180 "tax_id": "string", 181 "tax_ids": [ 182 { 183 "id": "string", 184 "type": "GENERIC_TAX_ID", 185 "display_name": "string", 186 "tax_id_validation_result": { 187 "id": "string", 188 "validation_date": "string", 189 "source": "string", 190 "valid": "VALID", 191 "message": "string" 192 } 193 } 194 ], 195 "registration_number": "string", 196 "registered_address": { 197 "line1": "string", 198 "line2": "string", 199 "city": "string", 200 "postal_code": "string", 201 "state": "string", 202 "country": "AD" 203 }, 204 "email": "string", 205 "tax_settings": { 206 "apply_local_vat_for_missing_tax_id": true 207 }, 208 "tax_registrations": [ 209 { 210 "id": "string", 211 "description": "string", 212 "tax_id": "string", 213 "tax_ids": [ 214 { 215 "id": "string", 216 "type": "GENERIC_TAX_ID", 217 "display_name": "string", 218 "tax_id_validation_result": { 219 "id": "string", 220 "validation_date": "string", 221 "source": "string", 222 "valid": "VALID", 223 "message": "string" 224 } 225 } 226 ], 227 "registration_number": "string", 228 "registered_address": { 229 "line1": "string", 230 "line2": "string", 231 "city": "string", 232 "postal_code": "string", 233 "state": "string", 234 "country": "AD" 235 } 236 } 237 ], 238 "custom_fields": [ 239 { 240 "id": "string", 241 "reference": "string", 242 "value": "string", 243 "values": [ 244 "string" 245 ], 246 "integration_details": { 247 "id": "string", 248 "reference": "string", 249 "payment_gateway_variant": "ADYEN", 250 "adyen": { 251 "recurring_detail_reference": "string" 252 }, 253 "stripe": { 254 "payment_method_id": "string" 255 } 256 }, 257 "integration_id": "string" 258 } 259 ], 260 "default_customer_country_selector": [ 261 "AD" 262 ], 263 "default_billing_currency_selector": [ 264 "AED" 265 ], 266 "linked_integrations": [ 267 { 268 "id": "string", 269 "link_details": [ 270 { 271 "url": "string", 272 "custom_field_name": "string" 273 } 274 ] 275 } 276 ] 277 }, 278 "status": "string", 279 "on_hold": true, 280 "type": "STANDARD", 281 "created_at": "string", 282 "updated_at": "string", 283 "invoice_date": "2024-01-15T09:30:00Z", 284 "delivery_date": "string", 285 "due_date": "2024-01-15T09:30:00Z", 286 "billing_period_date": "string", 287 "billing_currency": "string", 288 "invoice_amount_including_tax": { 289 "quantity": "string", 290 "currency": "AED" 291 }, 292 "open_invoice_amount": { 293 "quantity": "string", 294 "currency": "AED" 295 }, 296 "closed_invoice_amount": { 297 "quantity": "string", 298 "currency": "AED" 299 }, 300 "paid_invoice_amount": { 301 "quantity": "string", 302 "currency": "AED" 303 }, 304 "timezone": "string", 305 "billing_period": { 306 "type": "DAY", 307 "value": 1 308 }, 309 "pricing_plan_subscription_ids": [ 310 "string" 311 ], 312 "pricing_plan_schedule_ids": [ 313 "string" 314 ], 315 "pricing_amount_type": "EXCLUDING_TAX", 316 "periods": [ 317 { 318 "period_order": 1, 319 "amount_excluding_tax": { 320 "quantity": "string", 321 "currency": "AED" 322 }, 323 "amount_including_tax": { 324 "quantity": "string", 325 "currency": "AED" 326 }, 327 "billing_period": { 328 "type": "DAY", 329 "value": 1 330 }, 331 "start_at": "string", 332 "end_at": "string", 333 "tax_categories": [ 334 { 335 "base_amount": { 336 "quantity": "string", 337 "currency": "AED" 338 }, 339 "tax_amount": { 340 "quantity": "string", 341 "currency": "AED" 342 }, 343 "total_amount": { 344 "quantity": "string", 345 "currency": "AED" 346 }, 347 "category": "string", 348 "local_amounts": { 349 "base_amount": { 350 "quantity": "string", 351 "currency": "AED" 352 }, 353 "tax_amount": { 354 "quantity": "string", 355 "currency": "AED" 356 }, 357 "total_amount": { 358 "quantity": "string", 359 "currency": "AED" 360 }, 361 "used_exchange_rate": { 362 "currency": "string", 363 "base_currency": "string", 364 "rate_timestamp": "string", 365 "rate": "string", 366 "source": "string" 367 }, 368 "display": true 369 }, 370 "notes": [ 371 "string" 372 ], 373 "rates": [ 374 { 375 "name": "string", 376 "percentage": "string", 377 "tax_amount": { 378 "quantity": "string", 379 "currency": "AED" 380 } 381 } 382 ], 383 "percentage": "string", 384 "name": "string" 385 } 386 ], 387 "groups": [ 388 { 389 "group_order": 1, 390 "amount_excluding_tax": { 391 "quantity": "string", 392 "currency": "AED" 393 }, 394 "amount_including_tax": { 395 "quantity": "string", 396 "currency": "AED" 397 }, 398 "billing_period": { 399 "type": "DAY", 400 "value": 1 401 }, 402 "start_at": "string", 403 "end_at": "string", 404 "type": "string", 405 "product_category": { 406 "object_type": "string", 407 "id": "string", 408 "name": "string", 409 "reference": "string", 410 "description": "string", 411 "tax_category": "STANDARD", 412 "display_order": 1, 413 "customer_id": "string" 414 }, 415 "products": [ 416 { 417 "object_type": "string", 418 "id": "string", 419 "category_id": "string", 420 "category": { 421 "object_type": "string", 422 "id": "string", 423 "name": "string", 424 "reference": "string", 425 "description": "string", 426 "tax_category": "STANDARD", 427 "display_order": 1, 428 "customer_id": "string" 429 }, 430 "parent_product_id": "string", 431 "name": "string", 432 "reference": "string", 433 "description": "string", 434 "status": "DRAFT", 435 "product_type": "DEFAULT", 436 "tax_category": "STANDARD", 437 "features": [ 438 { 439 "id": "string", 440 "reference": "string" 441 } 442 ], 443 "custom_fields": [ 444 { 445 "id": "string", 446 "reference": "string", 447 "value": "string", 448 "values": [ 449 "string" 450 ], 451 "integration_details": { 452 "id": "string", 453 "reference": "string", 454 "payment_gateway_variant": "ADYEN", 455 "adyen": { 456 "recurring_detail_reference": "string" 457 }, 458 "stripe": { 459 "payment_method_id": "string" 460 } 461 }, 462 "integration_id": "string" 463 } 464 ], 465 "display_order": 1, 466 "linked_integrations": [ 467 { 468 "id": "string", 469 "link_details": [ 470 { 471 "url": "string", 472 "custom_field_name": "string" 473 } 474 ] 475 } 476 ], 477 "billing_entity_id": "string", 478 "customer_id": "string" 479 } 480 ], 481 "pricing": { 482 "id": "string", 483 "name": "string" 484 }, 485 "description": "string", 486 "pricing_plan_subscription_id": "string", 487 "pricing_plan_schedule_id": "string", 488 "forwarded_from_customer_id": "string", 489 "tax_categories": [ 490 { 491 "base_amount": { 492 "quantity": "string", 493 "currency": "AED" 494 }, 495 "tax_amount": { 496 "quantity": "string", 497 "currency": "AED" 498 }, 499 "total_amount": { 500 "quantity": "string", 501 "currency": "AED" 502 }, 503 "category": "string", 504 "local_amounts": { 505 "base_amount": { 506 "quantity": "string", 507 "currency": "AED" 508 }, 509 "tax_amount": { 510 "quantity": "string", 511 "currency": "AED" 512 }, 513 "total_amount": { 514 "quantity": "string", 515 "currency": "AED" 516 }, 517 "used_exchange_rate": { 518 "currency": "string", 519 "base_currency": "string", 520 "rate_timestamp": "string", 521 "rate": "string", 522 "source": "string" 523 }, 524 "display": true 525 }, 526 "notes": [ 527 "string" 528 ], 529 "rates": [ 530 { 531 "name": "string", 532 "percentage": "string", 533 "tax_amount": { 534 "quantity": "string", 535 "currency": "AED" 536 } 537 } 538 ], 539 "percentage": "string", 540 "name": "string" 541 } 542 ], 543 "lines": [ 544 { 545 "id": "string", 546 "line_order": 1, 547 "description": "string", 548 "pricing_item_id": "string", 549 "pricing_item_config_id": "string", 550 "product_items": [ 551 { 552 "object_type": "string", 553 "id": "string", 554 "product_id": "string", 555 "product": { 556 "object_type": "string", 557 "id": "string", 558 "category_id": "string", 559 "category": { 560 "object_type": "string", 561 "id": "string", 562 "name": "string", 563 "reference": "string", 564 "description": "string", 565 "tax_category": "STANDARD", 566 "display_order": 1, 567 "customer_id": "string" 568 }, 569 "parent_product_id": "string", 570 "name": "string", 571 "reference": "string", 572 "description": "string", 573 "status": "DRAFT", 574 "product_type": "DEFAULT", 575 "tax_category": "STANDARD", 576 "features": [ 577 { 578 "id": "string", 579 "reference": "string" 580 } 581 ], 582 "custom_fields": [ 583 { 584 "id": "string", 585 "reference": "string", 586 "value": "string", 587 "values": [ 588 "string" 589 ], 590 "integration_details": { 591 "id": "string", 592 "reference": "string", 593 "payment_gateway_variant": "ADYEN", 594 "adyen": { 595 "recurring_detail_reference": "string" 596 }, 597 "stripe": { 598 "payment_method_id": "string" 599 } 600 }, 601 "integration_id": "string" 602 } 603 ], 604 "display_order": 1, 605 "linked_integrations": [ 606 { 607 "id": "string", 608 "link_details": [ 609 { 610 "url": "string", 611 "custom_field_name": "string" 612 } 613 ] 614 } 615 ], 616 "billing_entity_id": "string", 617 "customer_id": "string" 618 }, 619 "name": "string", 620 "status": "DRAFT", 621 "reference": "string", 622 "description": "string", 623 "type": "REVENUE", 624 "model_type": "USAGE_BASED", 625 "usage_based": { 626 "meter_value_calculation_id": "string", 627 "meter_value_calculation": { 628 "object_type": "string", 629 "id": "string", 630 "reference": "string", 631 "name": "string", 632 "description": "string", 633 "calculation_type": "SUM", 634 "persist": true, 635 "meter_id": "string", 636 "meter": { 637 "object_type": "string", 638 "id": "string", 639 "reference": "string", 640 "name": "string", 641 "description": "string", 642 "status": "DRAFT", 643 "meter_values": [ 644 { 645 "id": "string", 646 "object": { 647 "object_type": "string", 648 "id": "string", 649 "reference": "string", 650 "name": "string", 651 "description": "string", 652 "status": "DRAFT", 653 "type": "NUMBER" 654 }, 655 "required": true 656 } 657 ], 658 "meter_properties": [ 659 { 660 "id": "string", 661 "object": { 662 "object_type": "string", 663 "id": "string", 664 "reference": "string", 665 "name": "string", 666 "description": "string", 667 "status": "DRAFT", 668 "type": "NUMBER", 669 "enum_values": [ 670 "string" 671 ] 672 }, 673 "required": true 674 } 675 ] 676 }, 677 "meter_value_id": "string", 678 "meter_value": { 679 "object_type": "string", 680 "id": "string", 681 "reference": "string", 682 "name": "string", 683 "description": "string", 684 "status": "DRAFT", 685 "type": "NUMBER" 686 }, 687 "meter_property_id": "string", 688 "meter_property": { 689 "object_type": "string", 690 "id": "string", 691 "reference": "string", 692 "name": "string", 693 "description": "string", 694 "status": "DRAFT", 695 "type": "NUMBER", 696 "enum_values": [ 697 "string" 698 ] 699 } 700 }, 701 "tiering_meter_value_calculation_id": "string", 702 "tiering_meter_value_calculation": { 703 "object_type": "string", 704 "id": "string", 705 "reference": "string", 706 "name": "string", 707 "description": "string", 708 "calculation_type": "SUM", 709 "persist": true, 710 "meter_id": "string", 711 "meter": { 712 "object_type": "string", 713 "id": "string", 714 "reference": "string", 715 "name": "string", 716 "description": "string", 717 "status": "DRAFT", 718 "meter_values": [ 719 { 720 "id": "string", 721 "object": { 722 "object_type": "string", 723 "id": "string", 724 "reference": "string", 725 "name": "string", 726 "description": "string", 727 "status": "DRAFT", 728 "type": "NUMBER" 729 }, 730 "required": true 731 } 732 ], 733 "meter_properties": [ 734 { 735 "id": "string", 736 "object": { 737 "object_type": "string", 738 "id": "string", 739 "reference": "string", 740 "name": "string", 741 "description": "string", 742 "status": "DRAFT", 743 "type": "NUMBER", 744 "enum_values": [ 745 "string" 746 ] 747 }, 748 "required": true 749 } 750 ] 751 }, 752 "meter_value_id": "string", 753 "meter_value": { 754 "object_type": "string", 755 "id": "string", 756 "reference": "string", 757 "name": "string", 758 "description": "string", 759 "status": "DRAFT", 760 "type": "NUMBER" 761 }, 762 "meter_property_id": "string", 763 "meter_property": { 764 "object_type": "string", 765 "id": "string", 766 "reference": "string", 767 "name": "string", 768 "description": "string", 769 "status": "DRAFT", 770 "type": "NUMBER", 771 "enum_values": [ 772 "string" 773 ] 774 } 775 }, 776 "report_meter_value_calculation_ids": [ 777 "string" 778 ], 779 "conditions": { 780 "name": "string", 781 "expression": { 782 "operator": "AND", 783 "operands": [ 784 { 785 "meter_property": { 786 "id": "string", 787 "reference": "string", 788 "meter_property": { 789 "object_type": "string", 790 "id": "string", 791 "reference": "string", 792 "name": "string", 793 "description": "string", 794 "status": "DRAFT", 795 "type": "NUMBER", 796 "enum_values": [ 797 "string" 798 ] 799 }, 800 "value": "string", 801 "values": [ 802 "string" 803 ], 804 "comparator": "EQUALS" 805 }, 806 "expression": {} 807 } 808 ] 809 }, 810 "meter_properties": [ 811 { 812 "id": "string", 813 "reference": "string", 814 "meter_property": { 815 "object_type": "string", 816 "id": "string", 817 "reference": "string", 818 "name": "string", 819 "description": "string", 820 "status": "DRAFT", 821 "type": "NUMBER", 822 "enum_values": [ 823 "string" 824 ] 825 }, 826 "value": "string", 827 "values": [ 828 "string" 829 ], 830 "comparator": "EQUALS" 831 } 832 ] 833 } 834 }, 835 "credits": { 836 "credit_type_id": "string", 837 "credit_type": { 838 "object_type": "string", 839 "id": "string", 840 "reference": "string", 841 "status": "DRAFT", 842 "name": "string", 843 "description": "string", 844 "unit_name": { 845 "singular": "string", 846 "plural": "string" 847 }, 848 "created_at": "string", 849 "updated_at": "string" 850 } 851 }, 852 "meter_value_calculation": { 853 "object_type": "string", 854 "id": "string", 855 "reference": "string", 856 "name": "string", 857 "description": "string", 858 "calculation_type": "SUM", 859 "persist": true, 860 "meter_id": "string", 861 "meter": { 862 "object_type": "string", 863 "id": "string", 864 "reference": "string", 865 "name": "string", 866 "description": "string", 867 "status": "DRAFT", 868 "meter_values": [ 869 { 870 "id": "string", 871 "object": { 872 "object_type": "string", 873 "id": "string", 874 "reference": "string", 875 "name": "string", 876 "description": "string", 877 "status": "DRAFT", 878 "type": "NUMBER" 879 }, 880 "required": true 881 } 882 ], 883 "meter_properties": [ 884 { 885 "id": "string", 886 "object": { 887 "object_type": "string", 888 "id": "string", 889 "reference": "string", 890 "name": "string", 891 "description": "string", 892 "status": "DRAFT", 893 "type": "NUMBER", 894 "enum_values": [ 895 "string" 896 ] 897 }, 898 "required": true 899 } 900 ] 901 }, 902 "meter_value_id": "string", 903 "meter_value": { 904 "object_type": "string", 905 "id": "string", 906 "reference": "string", 907 "name": "string", 908 "description": "string", 909 "status": "DRAFT", 910 "type": "NUMBER" 911 }, 912 "meter_property_id": "string", 913 "meter_property": { 914 "object_type": "string", 915 "id": "string", 916 "reference": "string", 917 "name": "string", 918 "description": "string", 919 "status": "DRAFT", 920 "type": "NUMBER", 921 "enum_values": [ 922 "string" 923 ] 924 } 925 }, 926 "tax_category": "STANDARD", 927 "display_order": 1, 928 "unit_name": { 929 "singular": "string", 930 "plural": "string" 931 }, 932 "custom_fields": [ 933 { 934 "id": "string", 935 "reference": "string", 936 "value": "string", 937 "values": [ 938 "string" 939 ], 940 "integration_details": { 941 "id": "string", 942 "reference": "string", 943 "payment_gateway_variant": "ADYEN", 944 "adyen": { 945 "recurring_detail_reference": "string" 946 }, 947 "stripe": { 948 "payment_method_id": "string" 949 } 950 }, 951 "integration_id": "string" 952 } 953 ], 954 "customer_id": "string", 955 "meter_value_calculation_id": "string", 956 "report_meter_value_calculation_ids": [ 957 "string" 958 ] 959 } 960 ], 961 "type": "string", 962 "pricing_type": "string", 963 "commitment_type": "string", 964 "discount_type": "string", 965 "coupon_data": { 966 "coupon_id": "string", 967 "promotion_code_id": "string" 968 }, 969 "tax_categories": [ 970 { 971 "base_amount": { 972 "quantity": "string", 973 "currency": "AED" 974 }, 975 "tax_amount": { 976 "quantity": "string", 977 "currency": "AED" 978 }, 979 "total_amount": { 980 "quantity": "string", 981 "currency": "AED" 982 }, 983 "category": "string", 984 "local_amounts": { 985 "base_amount": { 986 "quantity": "string", 987 "currency": "AED" 988 }, 989 "tax_amount": { 990 "quantity": "string", 991 "currency": "AED" 992 }, 993 "total_amount": { 994 "quantity": "string", 995 "currency": "AED" 996 }, 997 "used_exchange_rate": { 998 "currency": "string", 999 "base_currency": "string", 1000 "rate_timestamp": "string", 1001 "rate": "string", 1002 "source": "string" 1003 }, 1004 "display": true 1005 }, 1006 "notes": [ 1007 "string" 1008 ], 1009 "rates": [ 1010 { 1011 "name": "string", 1012 "percentage": "string", 1013 "tax_amount": { 1014 "quantity": "string", 1015 "currency": "AED" 1016 } 1017 } 1018 ], 1019 "percentage": "string", 1020 "name": "string" 1021 } 1022 ], 1023 "amount_excluding_tax": { 1024 "quantity": "string", 1025 "currency": "AED" 1026 }, 1027 "amount_including_tax": { 1028 "quantity": "string", 1029 "currency": "AED" 1030 }, 1031 "conditions": { 1032 "name": "string", 1033 "expression": { 1034 "operator": "AND", 1035 "operands": [ 1036 { 1037 "meter_property": { 1038 "id": "string", 1039 "reference": "string", 1040 "meter_property": { 1041 "object_type": "string", 1042 "id": "string", 1043 "reference": "string", 1044 "name": "string", 1045 "description": "string", 1046 "status": "DRAFT", 1047 "type": "NUMBER", 1048 "enum_values": [ 1049 "string" 1050 ] 1051 }, 1052 "value": "string", 1053 "values": [ 1054 "string" 1055 ], 1056 "comparator": "EQUALS" 1057 }, 1058 "expression": {} 1059 } 1060 ] 1061 }, 1062 "meter_properties": [ 1063 { 1064 "id": "string", 1065 "reference": "string", 1066 "meter_property": { 1067 "object_type": "string", 1068 "id": "string", 1069 "reference": "string", 1070 "name": "string", 1071 "description": "string", 1072 "status": "DRAFT", 1073 "type": "NUMBER", 1074 "enum_values": [ 1075 "string" 1076 ] 1077 }, 1078 "value": "string", 1079 "values": [ 1080 "string" 1081 ], 1082 "comparator": "EQUALS" 1083 } 1084 ] 1085 }, 1086 "meter_value": { 1087 "reference": "string", 1088 "type": "string", 1089 "number": "string", 1090 "amount": { 1091 "quantity": "string", 1092 "currency": "AED" 1093 } 1094 }, 1095 "details": { 1096 "amount": { 1097 "quantity": "string", 1098 "currency": "AED" 1099 }, 1100 "pricing_currency": "string", 1101 "pricing_amount": { 1102 "quantity": "string", 1103 "currency": "AED" 1104 }, 1105 "conversion": { 1106 "credits": { 1107 "quantity": "string", 1108 "credit_type_id": "string" 1109 }, 1110 "convert_from_meter_value_id": "string" 1111 }, 1112 "band": { 1113 "amount": { 1114 "quantity": "string", 1115 "currency": "AED" 1116 }, 1117 "percentage": "string", 1118 "credits": { 1119 "quantity": "string", 1120 "credit_type_id": "string" 1121 }, 1122 "maximum_amount": { 1123 "quantity": "string", 1124 "currency": "AED" 1125 }, 1126 "minimum_amount": { 1127 "quantity": "string", 1128 "currency": "AED" 1129 }, 1130 "maximum_number": "string", 1131 "minimum_number": "string", 1132 "block_size": { 1133 "number": "string", 1134 "amount": { 1135 "quantity": "string", 1136 "currency": "AED" 1137 }, 1138 "count": "string" 1139 }, 1140 "tier_lower_bound": { 1141 "number": "string", 1142 "amount": { 1143 "quantity": "string", 1144 "currency": "AED" 1145 }, 1146 "count": "string" 1147 }, 1148 "tier_top_bound": { 1149 "number": "string", 1150 "amount": { 1151 "quantity": "string", 1152 "currency": "AED" 1153 }, 1154 "count": "string" 1155 }, 1156 "volume_share": "string", 1157 "included_volume": { 1158 "number": "string", 1159 "amount": { 1160 "quantity": "string", 1161 "currency": "AED" 1162 }, 1163 "count": "string" 1164 } 1165 }, 1166 "meter_value": { 1167 "id": "string", 1168 "reference": "string", 1169 "number": "string", 1170 "amount": { 1171 "quantity": "string", 1172 "currency": "AED" 1173 }, 1174 "count": "string", 1175 "ratio": "string", 1176 "type": "NUMBER" 1177 }, 1178 "tiering_meter_value": { 1179 "id": "string", 1180 "reference": "string", 1181 "number": "string", 1182 "amount": { 1183 "quantity": "string", 1184 "currency": "AED" 1185 }, 1186 "count": "string", 1187 "ratio": "string", 1188 "type": "NUMBER" 1189 }, 1190 "price_bound": "string", 1191 "meter_values": [ 1192 { 1193 "number": "string", 1194 "amount": { 1195 "quantity": "string", 1196 "currency": "AED" 1197 }, 1198 "amount_in_pricing_currency": { 1199 "quantity": "string", 1200 "currency": "AED" 1201 }, 1202 "count": 1, 1203 "ratio": "string" 1204 } 1205 ], 1206 "report_meter_values": [ 1207 { 1208 "meter_value_calculation_id": "string", 1209 "number": "string", 1210 "amount": { 1211 "quantity": "string", 1212 "currency": "AED" 1213 }, 1214 "amount_in_pricing_currency": { 1215 "quantity": "string", 1216 "currency": "AED" 1217 }, 1218 "count": "string", 1219 "ratio": "string" 1220 } 1221 ], 1222 "description": "string", 1223 "used_exchange_rates": [ 1224 { 1225 "currency": "string", 1226 "base_currency": "string", 1227 "rate_timestamp": "string", 1228 "rate": "string", 1229 "source": "string" 1230 } 1231 ], 1232 "included_volume_details": { 1233 "included_volume": { 1234 "id": "string", 1235 "reference": "string", 1236 "number": "string", 1237 "amount": { 1238 "quantity": "string", 1239 "currency": "AED" 1240 }, 1241 "count": "string", 1242 "ratio": "string", 1243 "type": "NUMBER" 1244 }, 1245 "available_included_volume": { 1246 "id": "string", 1247 "reference": "string", 1248 "number": "string", 1249 "amount": { 1250 "quantity": "string", 1251 "currency": "AED" 1252 }, 1253 "count": "string", 1254 "ratio": "string", 1255 "type": "NUMBER" 1256 }, 1257 "period_volume": { 1258 "id": "string", 1259 "reference": "string", 1260 "number": "string", 1261 "amount": { 1262 "quantity": "string", 1263 "currency": "AED" 1264 }, 1265 "count": "string", 1266 "ratio": "string", 1267 "type": "NUMBER" 1268 } 1269 }, 1270 "wallet_balance_details": { 1271 "used_wallet_credits": { 1272 "quantity": "string", 1273 "credit_type_id": "string" 1274 }, 1275 "left_wallet_credits": { 1276 "quantity": "string", 1277 "credit_type_id": "string" 1278 }, 1279 "available_wallet_credits": { 1280 "quantity": "string", 1281 "credit_type_id": "string" 1282 } 1283 }, 1284 "split_pricing": { 1285 "meter_properties": [ 1286 { 1287 "id": "string", 1288 "reference": "string", 1289 "value": "string", 1290 "meter_property": { 1291 "object_type": "string", 1292 "id": "string", 1293 "reference": "string", 1294 "name": "string", 1295 "description": "string", 1296 "status": "DRAFT", 1297 "type": "NUMBER", 1298 "enum_values": [ 1299 "string" 1300 ] 1301 } 1302 } 1303 ] 1304 }, 1305 "meter_value_share_of_total": "string", 1306 "meter_value_share_of_processing_only_customer_total": "string" 1307 }, 1308 "sub_lines": [ 1309 { 1310 "sub_line_order": 1, 1311 "details": { 1312 "amount": { 1313 "quantity": "string", 1314 "currency": "AED" 1315 }, 1316 "pricing_currency": "string", 1317 "pricing_amount": { 1318 "quantity": "string", 1319 "currency": "AED" 1320 }, 1321 "conversion": { 1322 "credits": { 1323 "quantity": "string", 1324 "credit_type_id": "string" 1325 }, 1326 "convert_from_meter_value_id": "string" 1327 }, 1328 "band": { 1329 "amount": { 1330 "quantity": "string", 1331 "currency": "AED" 1332 }, 1333 "percentage": "string", 1334 "credits": { 1335 "quantity": "string", 1336 "credit_type_id": "string" 1337 }, 1338 "maximum_amount": { 1339 "quantity": "string", 1340 "currency": "AED" 1341 }, 1342 "minimum_amount": { 1343 "quantity": "string", 1344 "currency": "AED" 1345 }, 1346 "maximum_number": "string", 1347 "minimum_number": "string", 1348 "block_size": { 1349 "number": "string", 1350 "amount": { 1351 "quantity": "string", 1352 "currency": "AED" 1353 }, 1354 "count": "string" 1355 }, 1356 "tier_lower_bound": { 1357 "number": "string", 1358 "amount": { 1359 "quantity": "string", 1360 "currency": "AED" 1361 }, 1362 "count": "string" 1363 }, 1364 "tier_top_bound": { 1365 "number": "string", 1366 "amount": { 1367 "quantity": "string", 1368 "currency": "AED" 1369 }, 1370 "count": "string" 1371 }, 1372 "volume_share": "string", 1373 "included_volume": { 1374 "number": "string", 1375 "amount": { 1376 "quantity": "string", 1377 "currency": "AED" 1378 }, 1379 "count": "string" 1380 } 1381 }, 1382 "meter_value": { 1383 "id": "string", 1384 "reference": "string", 1385 "number": "string", 1386 "amount": { 1387 "quantity": "string", 1388 "currency": "AED" 1389 }, 1390 "count": "string", 1391 "ratio": "string", 1392 "type": "NUMBER" 1393 }, 1394 "tiering_meter_value": { 1395 "id": "string", 1396 "reference": "string", 1397 "number": "string", 1398 "amount": { 1399 "quantity": "string", 1400 "currency": "AED" 1401 }, 1402 "count": "string", 1403 "ratio": "string", 1404 "type": "NUMBER" 1405 }, 1406 "price_bound": "string", 1407 "meter_values": [ 1408 { 1409 "number": "string", 1410 "amount": { 1411 "quantity": "string", 1412 "currency": "AED" 1413 }, 1414 "amount_in_pricing_currency": { 1415 "quantity": "string", 1416 "currency": "AED" 1417 }, 1418 "count": 1, 1419 "ratio": "string" 1420 } 1421 ], 1422 "report_meter_values": [ 1423 { 1424 "meter_value_calculation_id": "string", 1425 "number": "string", 1426 "amount": { 1427 "quantity": "string", 1428 "currency": "AED" 1429 }, 1430 "amount_in_pricing_currency": { 1431 "quantity": "string", 1432 "currency": "AED" 1433 }, 1434 "count": "string", 1435 "ratio": "string" 1436 } 1437 ], 1438 "description": "string", 1439 "used_exchange_rates": [ 1440 { 1441 "currency": "string", 1442 "base_currency": "string", 1443 "rate_timestamp": "string", 1444 "rate": "string", 1445 "source": "string" 1446 } 1447 ], 1448 "included_volume_details": { 1449 "included_volume": { 1450 "id": "string", 1451 "reference": "string", 1452 "number": "string", 1453 "amount": { 1454 "quantity": "string", 1455 "currency": "AED" 1456 }, 1457 "count": "string", 1458 "ratio": "string", 1459 "type": "NUMBER" 1460 }, 1461 "available_included_volume": { 1462 "id": "string", 1463 "reference": "string", 1464 "number": "string", 1465 "amount": { 1466 "quantity": "string", 1467 "currency": "AED" 1468 }, 1469 "count": "string", 1470 "ratio": "string", 1471 "type": "NUMBER" 1472 }, 1473 "period_volume": { 1474 "id": "string", 1475 "reference": "string", 1476 "number": "string", 1477 "amount": { 1478 "quantity": "string", 1479 "currency": "AED" 1480 }, 1481 "count": "string", 1482 "ratio": "string", 1483 "type": "NUMBER" 1484 } 1485 }, 1486 "wallet_balance_details": { 1487 "used_wallet_credits": { 1488 "quantity": "string", 1489 "credit_type_id": "string" 1490 }, 1491 "left_wallet_credits": { 1492 "quantity": "string", 1493 "credit_type_id": "string" 1494 }, 1495 "available_wallet_credits": { 1496 "quantity": "string", 1497 "credit_type_id": "string" 1498 } 1499 }, 1500 "split_pricing": { 1501 "meter_properties": [ 1502 { 1503 "id": "string", 1504 "reference": "string", 1505 "value": "string", 1506 "meter_property": { 1507 "object_type": "string", 1508 "id": "string", 1509 "reference": "string", 1510 "name": "string", 1511 "description": "string", 1512 "status": "DRAFT", 1513 "type": "NUMBER", 1514 "enum_values": [ 1515 "string" 1516 ] 1517 } 1518 } 1519 ] 1520 }, 1521 "meter_value_share_of_total": "string", 1522 "meter_value_share_of_processing_only_customer_total": "string" 1523 }, 1524 "description": "string", 1525 "processing_only_customer_id": "string", 1526 "type": "USAGE_BASED_CONVERSION", 1527 "usage_based_conversion": { 1528 "conditions": { 1529 "name": "string", 1530 "expression": { 1531 "operator": "AND", 1532 "operands": [ 1533 { 1534 "meter_property": { 1535 "id": "string", 1536 "reference": "string", 1537 "meter_property": { 1538 "object_type": "string", 1539 "id": "string", 1540 "reference": "string", 1541 "name": "string", 1542 "description": "string", 1543 "status": "DRAFT", 1544 "type": "NUMBER", 1545 "enum_values": [ 1546 "string" 1547 ] 1548 }, 1549 "value": "string", 1550 "values": [ 1551 "string" 1552 ], 1553 "comparator": "EQUALS" 1554 }, 1555 "expression": {} 1556 } 1557 ] 1558 }, 1559 "meter_properties": [ 1560 { 1561 "id": "string", 1562 "reference": "string", 1563 "meter_property": { 1564 "object_type": "string", 1565 "id": "string", 1566 "reference": "string", 1567 "name": "string", 1568 "description": "string", 1569 "status": "DRAFT", 1570 "type": "NUMBER", 1571 "enum_values": [ 1572 "string" 1573 ] 1574 }, 1575 "value": "string", 1576 "values": [ 1577 "string" 1578 ], 1579 "comparator": "EQUALS" 1580 } 1581 ] 1582 } 1583 }, 1584 "processing_only_customer_resource_id": "string" 1585 } 1586 ] 1587 } 1588 ], 1589 "billing_customer_id": "string" 1590 } 1591 ] 1592 } 1593 ], 1594 "closed_periods": [ 1595 { 1596 "period_order": 1, 1597 "amount_excluding_tax": { 1598 "quantity": "string", 1599 "currency": "AED" 1600 }, 1601 "amount_including_tax": { 1602 "quantity": "string", 1603 "currency": "AED" 1604 }, 1605 "billing_period": { 1606 "type": "DAY", 1607 "value": 1 1608 }, 1609 "start_at": "string", 1610 "end_at": "string", 1611 "tax_categories": [ 1612 { 1613 "base_amount": { 1614 "quantity": "string", 1615 "currency": "AED" 1616 }, 1617 "tax_amount": { 1618 "quantity": "string", 1619 "currency": "AED" 1620 }, 1621 "total_amount": { 1622 "quantity": "string", 1623 "currency": "AED" 1624 }, 1625 "category": "string", 1626 "local_amounts": { 1627 "base_amount": { 1628 "quantity": "string", 1629 "currency": "AED" 1630 }, 1631 "tax_amount": { 1632 "quantity": "string", 1633 "currency": "AED" 1634 }, 1635 "total_amount": { 1636 "quantity": "string", 1637 "currency": "AED" 1638 }, 1639 "used_exchange_rate": { 1640 "currency": "string", 1641 "base_currency": "string", 1642 "rate_timestamp": "string", 1643 "rate": "string", 1644 "source": "string" 1645 }, 1646 "display": true 1647 }, 1648 "notes": [ 1649 "string" 1650 ], 1651 "rates": [ 1652 { 1653 "name": "string", 1654 "percentage": "string", 1655 "tax_amount": { 1656 "quantity": "string", 1657 "currency": "AED" 1658 } 1659 } 1660 ], 1661 "percentage": "string", 1662 "name": "string" 1663 } 1664 ], 1665 "groups": [ 1666 { 1667 "group_order": 1, 1668 "amount_excluding_tax": { 1669 "quantity": "string", 1670 "currency": "AED" 1671 }, 1672 "amount_including_tax": { 1673 "quantity": "string", 1674 "currency": "AED" 1675 }, 1676 "billing_period": { 1677 "type": "DAY", 1678 "value": 1 1679 }, 1680 "start_at": "string", 1681 "end_at": "string", 1682 "type": "string", 1683 "product_category": { 1684 "object_type": "string", 1685 "id": "string", 1686 "name": "string", 1687 "reference": "string", 1688 "description": "string", 1689 "tax_category": "STANDARD", 1690 "display_order": 1, 1691 "customer_id": "string" 1692 }, 1693 "products": [ 1694 { 1695 "object_type": "string", 1696 "id": "string", 1697 "category_id": "string", 1698 "category": { 1699 "object_type": "string", 1700 "id": "string", 1701 "name": "string", 1702 "reference": "string", 1703 "description": "string", 1704 "tax_category": "STANDARD", 1705 "display_order": 1, 1706 "customer_id": "string" 1707 }, 1708 "parent_product_id": "string", 1709 "name": "string", 1710 "reference": "string", 1711 "description": "string", 1712 "status": "DRAFT", 1713 "product_type": "DEFAULT", 1714 "tax_category": "STANDARD", 1715 "features": [ 1716 { 1717 "id": "string", 1718 "reference": "string" 1719 } 1720 ], 1721 "custom_fields": [ 1722 { 1723 "id": "string", 1724 "reference": "string", 1725 "value": "string", 1726 "values": [ 1727 "string" 1728 ], 1729 "integration_details": { 1730 "id": "string", 1731 "reference": "string", 1732 "payment_gateway_variant": "ADYEN", 1733 "adyen": { 1734 "recurring_detail_reference": "string" 1735 }, 1736 "stripe": { 1737 "payment_method_id": "string" 1738 } 1739 }, 1740 "integration_id": "string" 1741 } 1742 ], 1743 "display_order": 1, 1744 "linked_integrations": [ 1745 { 1746 "id": "string", 1747 "link_details": [ 1748 { 1749 "url": "string", 1750 "custom_field_name": "string" 1751 } 1752 ] 1753 } 1754 ], 1755 "billing_entity_id": "string", 1756 "customer_id": "string" 1757 } 1758 ], 1759 "pricing": { 1760 "id": "string", 1761 "name": "string" 1762 }, 1763 "description": "string", 1764 "pricing_plan_subscription_id": "string", 1765 "pricing_plan_schedule_id": "string", 1766 "forwarded_from_customer_id": "string", 1767 "tax_categories": [ 1768 { 1769 "base_amount": { 1770 "quantity": "string", 1771 "currency": "AED" 1772 }, 1773 "tax_amount": { 1774 "quantity": "string", 1775 "currency": "AED" 1776 }, 1777 "total_amount": { 1778 "quantity": "string", 1779 "currency": "AED" 1780 }, 1781 "category": "string", 1782 "local_amounts": { 1783 "base_amount": { 1784 "quantity": "string", 1785 "currency": "AED" 1786 }, 1787 "tax_amount": { 1788 "quantity": "string", 1789 "currency": "AED" 1790 }, 1791 "total_amount": { 1792 "quantity": "string", 1793 "currency": "AED" 1794 }, 1795 "used_exchange_rate": { 1796 "currency": "string", 1797 "base_currency": "string", 1798 "rate_timestamp": "string", 1799 "rate": "string", 1800 "source": "string" 1801 }, 1802 "display": true 1803 }, 1804 "notes": [ 1805 "string" 1806 ], 1807 "rates": [ 1808 { 1809 "name": "string", 1810 "percentage": "string", 1811 "tax_amount": { 1812 "quantity": "string", 1813 "currency": "AED" 1814 } 1815 } 1816 ], 1817 "percentage": "string", 1818 "name": "string" 1819 } 1820 ], 1821 "lines": [ 1822 { 1823 "id": "string", 1824 "line_order": 1, 1825 "description": "string", 1826 "pricing_item_id": "string", 1827 "pricing_item_config_id": "string", 1828 "product_items": [ 1829 { 1830 "object_type": "string", 1831 "id": "string", 1832 "product_id": "string", 1833 "product": { 1834 "object_type": "string", 1835 "id": "string", 1836 "category_id": "string", 1837 "category": { 1838 "object_type": "string", 1839 "id": "string", 1840 "name": "string", 1841 "reference": "string", 1842 "description": "string", 1843 "tax_category": "STANDARD", 1844 "display_order": 1, 1845 "customer_id": "string" 1846 }, 1847 "parent_product_id": "string", 1848 "name": "string", 1849 "reference": "string", 1850 "description": "string", 1851 "status": "DRAFT", 1852 "product_type": "DEFAULT", 1853 "tax_category": "STANDARD", 1854 "features": [ 1855 { 1856 "id": "string", 1857 "reference": "string" 1858 } 1859 ], 1860 "custom_fields": [ 1861 { 1862 "id": "string", 1863 "reference": "string", 1864 "value": "string", 1865 "values": [ 1866 "string" 1867 ], 1868 "integration_details": { 1869 "id": "string", 1870 "reference": "string", 1871 "payment_gateway_variant": "ADYEN", 1872 "adyen": { 1873 "recurring_detail_reference": "string" 1874 }, 1875 "stripe": { 1876 "payment_method_id": "string" 1877 } 1878 }, 1879 "integration_id": "string" 1880 } 1881 ], 1882 "display_order": 1, 1883 "linked_integrations": [ 1884 { 1885 "id": "string", 1886 "link_details": [ 1887 { 1888 "url": "string", 1889 "custom_field_name": "string" 1890 } 1891 ] 1892 } 1893 ], 1894 "billing_entity_id": "string", 1895 "customer_id": "string" 1896 }, 1897 "name": "string", 1898 "status": "DRAFT", 1899 "reference": "string", 1900 "description": "string", 1901 "type": "REVENUE", 1902 "model_type": "USAGE_BASED", 1903 "usage_based": { 1904 "meter_value_calculation_id": "string", 1905 "meter_value_calculation": { 1906 "object_type": "string", 1907 "id": "string", 1908 "reference": "string", 1909 "name": "string", 1910 "description": "string", 1911 "calculation_type": "SUM", 1912 "persist": true, 1913 "meter_id": "string", 1914 "meter": { 1915 "object_type": "string", 1916 "id": "string", 1917 "reference": "string", 1918 "name": "string", 1919 "description": "string", 1920 "status": "DRAFT", 1921 "meter_values": [ 1922 { 1923 "id": "string", 1924 "object": { 1925 "object_type": "string", 1926 "id": "string", 1927 "reference": "string", 1928 "name": "string", 1929 "description": "string", 1930 "status": "DRAFT", 1931 "type": "NUMBER" 1932 }, 1933 "required": true 1934 } 1935 ], 1936 "meter_properties": [ 1937 { 1938 "id": "string", 1939 "object": { 1940 "object_type": "string", 1941 "id": "string", 1942 "reference": "string", 1943 "name": "string", 1944 "description": "string", 1945 "status": "DRAFT", 1946 "type": "NUMBER", 1947 "enum_values": [ 1948 "string" 1949 ] 1950 }, 1951 "required": true 1952 } 1953 ] 1954 }, 1955 "meter_value_id": "string", 1956 "meter_value": { 1957 "object_type": "string", 1958 "id": "string", 1959 "reference": "string", 1960 "name": "string", 1961 "description": "string", 1962 "status": "DRAFT", 1963 "type": "NUMBER" 1964 }, 1965 "meter_property_id": "string", 1966 "meter_property": { 1967 "object_type": "string", 1968 "id": "string", 1969 "reference": "string", 1970 "name": "string", 1971 "description": "string", 1972 "status": "DRAFT", 1973 "type": "NUMBER", 1974 "enum_values": [ 1975 "string" 1976 ] 1977 } 1978 }, 1979 "tiering_meter_value_calculation_id": "string", 1980 "tiering_meter_value_calculation": { 1981 "object_type": "string", 1982 "id": "string", 1983 "reference": "string", 1984 "name": "string", 1985 "description": "string", 1986 "calculation_type": "SUM", 1987 "persist": true, 1988 "meter_id": "string", 1989 "meter": { 1990 "object_type": "string", 1991 "id": "string", 1992 "reference": "string", 1993 "name": "string", 1994 "description": "string", 1995 "status": "DRAFT", 1996 "meter_values": [ 1997 { 1998 "id": "string", 1999 "object": { 2000 "object_type": "string", 2001 "id": "string", 2002 "reference": "string", 2003 "name": "string", 2004 "description": "string", 2005 "status": "DRAFT", 2006 "type": "NUMBER" 2007 }, 2008 "required": true 2009 } 2010 ], 2011 "meter_properties": [ 2012 { 2013 "id": "string", 2014 "object": { 2015 "object_type": "string", 2016 "id": "string", 2017 "reference": "string", 2018 "name": "string", 2019 "description": "string", 2020 "status": "DRAFT", 2021 "type": "NUMBER", 2022 "enum_values": [ 2023 "string" 2024 ] 2025 }, 2026 "required": true 2027 } 2028 ] 2029 }, 2030 "meter_value_id": "string", 2031 "meter_value": { 2032 "object_type": "string", 2033 "id": "string", 2034 "reference": "string", 2035 "name": "string", 2036 "description": "string", 2037 "status": "DRAFT", 2038 "type": "NUMBER" 2039 }, 2040 "meter_property_id": "string", 2041 "meter_property": { 2042 "object_type": "string", 2043 "id": "string", 2044 "reference": "string", 2045 "name": "string", 2046 "description": "string", 2047 "status": "DRAFT", 2048 "type": "NUMBER", 2049 "enum_values": [ 2050 "string" 2051 ] 2052 } 2053 }, 2054 "report_meter_value_calculation_ids": [ 2055 "string" 2056 ], 2057 "conditions": { 2058 "name": "string", 2059 "expression": { 2060 "operator": "AND", 2061 "operands": [ 2062 { 2063 "meter_property": { 2064 "id": "string", 2065 "reference": "string", 2066 "meter_property": { 2067 "object_type": "string", 2068 "id": "string", 2069 "reference": "string", 2070 "name": "string", 2071 "description": "string", 2072 "status": "DRAFT", 2073 "type": "NUMBER", 2074 "enum_values": [ 2075 "string" 2076 ] 2077 }, 2078 "value": "string", 2079 "values": [ 2080 "string" 2081 ], 2082 "comparator": "EQUALS" 2083 }, 2084 "expression": {} 2085 } 2086 ] 2087 }, 2088 "meter_properties": [ 2089 { 2090 "id": "string", 2091 "reference": "string", 2092 "meter_property": { 2093 "object_type": "string", 2094 "id": "string", 2095 "reference": "string", 2096 "name": "string", 2097 "description": "string", 2098 "status": "DRAFT", 2099 "type": "NUMBER", 2100 "enum_values": [ 2101 "string" 2102 ] 2103 }, 2104 "value": "string", 2105 "values": [ 2106 "string" 2107 ], 2108 "comparator": "EQUALS" 2109 } 2110 ] 2111 } 2112 }, 2113 "credits": { 2114 "credit_type_id": "string", 2115 "credit_type": { 2116 "object_type": "string", 2117 "id": "string", 2118 "reference": "string", 2119 "status": "DRAFT", 2120 "name": "string", 2121 "description": "string", 2122 "unit_name": { 2123 "singular": "string", 2124 "plural": "string" 2125 }, 2126 "created_at": "string", 2127 "updated_at": "string" 2128 } 2129 }, 2130 "meter_value_calculation": { 2131 "object_type": "string", 2132 "id": "string", 2133 "reference": "string", 2134 "name": "string", 2135 "description": "string", 2136 "calculation_type": "SUM", 2137 "persist": true, 2138 "meter_id": "string", 2139 "meter": { 2140 "object_type": "string", 2141 "id": "string", 2142 "reference": "string", 2143 "name": "string", 2144 "description": "string", 2145 "status": "DRAFT", 2146 "meter_values": [ 2147 { 2148 "id": "string", 2149 "object": { 2150 "object_type": "string", 2151 "id": "string", 2152 "reference": "string", 2153 "name": "string", 2154 "description": "string", 2155 "status": "DRAFT", 2156 "type": "NUMBER" 2157 }, 2158 "required": true 2159 } 2160 ], 2161 "meter_properties": [ 2162 { 2163 "id": "string", 2164 "object": { 2165 "object_type": "string", 2166 "id": "string", 2167 "reference": "string", 2168 "name": "string", 2169 "description": "string", 2170 "status": "DRAFT", 2171 "type": "NUMBER", 2172 "enum_values": [ 2173 "string" 2174 ] 2175 }, 2176 "required": true 2177 } 2178 ] 2179 }, 2180 "meter_value_id": "string", 2181 "meter_value": { 2182 "object_type": "string", 2183 "id": "string", 2184 "reference": "string", 2185 "name": "string", 2186 "description": "string", 2187 "status": "DRAFT", 2188 "type": "NUMBER" 2189 }, 2190 "meter_property_id": "string", 2191 "meter_property": { 2192 "object_type": "string", 2193 "id": "string", 2194 "reference": "string", 2195 "name": "string", 2196 "description": "string", 2197 "status": "DRAFT", 2198 "type": "NUMBER", 2199 "enum_values": [ 2200 "string" 2201 ] 2202 } 2203 }, 2204 "tax_category": "STANDARD", 2205 "display_order": 1, 2206 "unit_name": { 2207 "singular": "string", 2208 "plural": "string" 2209 }, 2210 "custom_fields": [ 2211 { 2212 "id": "string", 2213 "reference": "string", 2214 "value": "string", 2215 "values": [ 2216 "string" 2217 ], 2218 "integration_details": { 2219 "id": "string", 2220 "reference": "string", 2221 "payment_gateway_variant": "ADYEN", 2222 "adyen": { 2223 "recurring_detail_reference": "string" 2224 }, 2225 "stripe": { 2226 "payment_method_id": "string" 2227 } 2228 }, 2229 "integration_id": "string" 2230 } 2231 ], 2232 "customer_id": "string", 2233 "meter_value_calculation_id": "string", 2234 "report_meter_value_calculation_ids": [ 2235 "string" 2236 ] 2237 } 2238 ], 2239 "type": "string", 2240 "pricing_type": "string", 2241 "commitment_type": "string", 2242 "discount_type": "string", 2243 "coupon_data": { 2244 "coupon_id": "string", 2245 "promotion_code_id": "string" 2246 }, 2247 "tax_categories": [ 2248 { 2249 "base_amount": { 2250 "quantity": "string", 2251 "currency": "AED" 2252 }, 2253 "tax_amount": { 2254 "quantity": "string", 2255 "currency": "AED" 2256 }, 2257 "total_amount": { 2258 "quantity": "string", 2259 "currency": "AED" 2260 }, 2261 "category": "string", 2262 "local_amounts": { 2263 "base_amount": { 2264 "quantity": "string", 2265 "currency": "AED" 2266 }, 2267 "tax_amount": { 2268 "quantity": "string", 2269 "currency": "AED" 2270 }, 2271 "total_amount": { 2272 "quantity": "string", 2273 "currency": "AED" 2274 }, 2275 "used_exchange_rate": { 2276 "currency": "string", 2277 "base_currency": "string", 2278 "rate_timestamp": "string", 2279 "rate": "string", 2280 "source": "string" 2281 }, 2282 "display": true 2283 }, 2284 "notes": [ 2285 "string" 2286 ], 2287 "rates": [ 2288 { 2289 "name": "string", 2290 "percentage": "string", 2291 "tax_amount": { 2292 "quantity": "string", 2293 "currency": "AED" 2294 } 2295 } 2296 ], 2297 "percentage": "string", 2298 "name": "string" 2299 } 2300 ], 2301 "amount_excluding_tax": { 2302 "quantity": "string", 2303 "currency": "AED" 2304 }, 2305 "amount_including_tax": { 2306 "quantity": "string", 2307 "currency": "AED" 2308 }, 2309 "conditions": { 2310 "name": "string", 2311 "expression": { 2312 "operator": "AND", 2313 "operands": [ 2314 { 2315 "meter_property": { 2316 "id": "string", 2317 "reference": "string", 2318 "meter_property": { 2319 "object_type": "string", 2320 "id": "string", 2321 "reference": "string", 2322 "name": "string", 2323 "description": "string", 2324 "status": "DRAFT", 2325 "type": "NUMBER", 2326 "enum_values": [ 2327 "string" 2328 ] 2329 }, 2330 "value": "string", 2331 "values": [ 2332 "string" 2333 ], 2334 "comparator": "EQUALS" 2335 }, 2336 "expression": {} 2337 } 2338 ] 2339 }, 2340 "meter_properties": [ 2341 { 2342 "id": "string", 2343 "reference": "string", 2344 "meter_property": { 2345 "object_type": "string", 2346 "id": "string", 2347 "reference": "string", 2348 "name": "string", 2349 "description": "string", 2350 "status": "DRAFT", 2351 "type": "NUMBER", 2352 "enum_values": [ 2353 "string" 2354 ] 2355 }, 2356 "value": "string", 2357 "values": [ 2358 "string" 2359 ], 2360 "comparator": "EQUALS" 2361 } 2362 ] 2363 }, 2364 "meter_value": { 2365 "reference": "string", 2366 "type": "string", 2367 "number": "string", 2368 "amount": { 2369 "quantity": "string", 2370 "currency": "AED" 2371 } 2372 }, 2373 "details": { 2374 "amount": { 2375 "quantity": "string", 2376 "currency": "AED" 2377 }, 2378 "pricing_currency": "string", 2379 "pricing_amount": { 2380 "quantity": "string", 2381 "currency": "AED" 2382 }, 2383 "conversion": { 2384 "credits": { 2385 "quantity": "string", 2386 "credit_type_id": "string" 2387 }, 2388 "convert_from_meter_value_id": "string" 2389 }, 2390 "band": { 2391 "amount": { 2392 "quantity": "string", 2393 "currency": "AED" 2394 }, 2395 "percentage": "string", 2396 "credits": { 2397 "quantity": "string", 2398 "credit_type_id": "string" 2399 }, 2400 "maximum_amount": { 2401 "quantity": "string", 2402 "currency": "AED" 2403 }, 2404 "minimum_amount": { 2405 "quantity": "string", 2406 "currency": "AED" 2407 }, 2408 "maximum_number": "string", 2409 "minimum_number": "string", 2410 "block_size": { 2411 "number": "string", 2412 "amount": { 2413 "quantity": "string", 2414 "currency": "AED" 2415 }, 2416 "count": "string" 2417 }, 2418 "tier_lower_bound": { 2419 "number": "string", 2420 "amount": { 2421 "quantity": "string", 2422 "currency": "AED" 2423 }, 2424 "count": "string" 2425 }, 2426 "tier_top_bound": { 2427 "number": "string", 2428 "amount": { 2429 "quantity": "string", 2430 "currency": "AED" 2431 }, 2432 "count": "string" 2433 }, 2434 "volume_share": "string", 2435 "included_volume": { 2436 "number": "string", 2437 "amount": { 2438 "quantity": "string", 2439 "currency": "AED" 2440 }, 2441 "count": "string" 2442 } 2443 }, 2444 "meter_value": { 2445 "id": "string", 2446 "reference": "string", 2447 "number": "string", 2448 "amount": { 2449 "quantity": "string", 2450 "currency": "AED" 2451 }, 2452 "count": "string", 2453 "ratio": "string", 2454 "type": "NUMBER" 2455 }, 2456 "tiering_meter_value": { 2457 "id": "string", 2458 "reference": "string", 2459 "number": "string", 2460 "amount": { 2461 "quantity": "string", 2462 "currency": "AED" 2463 }, 2464 "count": "string", 2465 "ratio": "string", 2466 "type": "NUMBER" 2467 }, 2468 "price_bound": "string", 2469 "meter_values": [ 2470 { 2471 "number": "string", 2472 "amount": { 2473 "quantity": "string", 2474 "currency": "AED" 2475 }, 2476 "amount_in_pricing_currency": { 2477 "quantity": "string", 2478 "currency": "AED" 2479 }, 2480 "count": 1, 2481 "ratio": "string" 2482 } 2483 ], 2484 "report_meter_values": [ 2485 { 2486 "meter_value_calculation_id": "string", 2487 "number": "string", 2488 "amount": { 2489 "quantity": "string", 2490 "currency": "AED" 2491 }, 2492 "amount_in_pricing_currency": { 2493 "quantity": "string", 2494 "currency": "AED" 2495 }, 2496 "count": "string", 2497 "ratio": "string" 2498 } 2499 ], 2500 "description": "string", 2501 "used_exchange_rates": [ 2502 { 2503 "currency": "string", 2504 "base_currency": "string", 2505 "rate_timestamp": "string", 2506 "rate": "string", 2507 "source": "string" 2508 } 2509 ], 2510 "included_volume_details": { 2511 "included_volume": { 2512 "id": "string", 2513 "reference": "string", 2514 "number": "string", 2515 "amount": { 2516 "quantity": "string", 2517 "currency": "AED" 2518 }, 2519 "count": "string", 2520 "ratio": "string", 2521 "type": "NUMBER" 2522 }, 2523 "available_included_volume": { 2524 "id": "string", 2525 "reference": "string", 2526 "number": "string", 2527 "amount": { 2528 "quantity": "string", 2529 "currency": "AED" 2530 }, 2531 "count": "string", 2532 "ratio": "string", 2533 "type": "NUMBER" 2534 }, 2535 "period_volume": { 2536 "id": "string", 2537 "reference": "string", 2538 "number": "string", 2539 "amount": { 2540 "quantity": "string", 2541 "currency": "AED" 2542 }, 2543 "count": "string", 2544 "ratio": "string", 2545 "type": "NUMBER" 2546 } 2547 }, 2548 "wallet_balance_details": { 2549 "used_wallet_credits": { 2550 "quantity": "string", 2551 "credit_type_id": "string" 2552 }, 2553 "left_wallet_credits": { 2554 "quantity": "string", 2555 "credit_type_id": "string" 2556 }, 2557 "available_wallet_credits": { 2558 "quantity": "string", 2559 "credit_type_id": "string" 2560 } 2561 }, 2562 "split_pricing": { 2563 "meter_properties": [ 2564 { 2565 "id": "string", 2566 "reference": "string", 2567 "value": "string", 2568 "meter_property": { 2569 "object_type": "string", 2570 "id": "string", 2571 "reference": "string", 2572 "name": "string", 2573 "description": "string", 2574 "status": "DRAFT", 2575 "type": "NUMBER", 2576 "enum_values": [ 2577 "string" 2578 ] 2579 } 2580 } 2581 ] 2582 }, 2583 "meter_value_share_of_total": "string", 2584 "meter_value_share_of_processing_only_customer_total": "string" 2585 }, 2586 "sub_lines": [ 2587 { 2588 "sub_line_order": 1, 2589 "details": { 2590 "amount": { 2591 "quantity": "string", 2592 "currency": "AED" 2593 }, 2594 "pricing_currency": "string", 2595 "pricing_amount": { 2596 "quantity": "string", 2597 "currency": "AED" 2598 }, 2599 "conversion": { 2600 "credits": { 2601 "quantity": "string", 2602 "credit_type_id": "string" 2603 }, 2604 "convert_from_meter_value_id": "string" 2605 }, 2606 "band": { 2607 "amount": { 2608 "quantity": "string", 2609 "currency": "AED" 2610 }, 2611 "percentage": "string", 2612 "credits": { 2613 "quantity": "string", 2614 "credit_type_id": "string" 2615 }, 2616 "maximum_amount": { 2617 "quantity": "string", 2618 "currency": "AED" 2619 }, 2620 "minimum_amount": { 2621 "quantity": "string", 2622 "currency": "AED" 2623 }, 2624 "maximum_number": "string", 2625 "minimum_number": "string", 2626 "block_size": { 2627 "number": "string", 2628 "amount": { 2629 "quantity": "string", 2630 "currency": "AED" 2631 }, 2632 "count": "string" 2633 }, 2634 "tier_lower_bound": { 2635 "number": "string", 2636 "amount": { 2637 "quantity": "string", 2638 "currency": "AED" 2639 }, 2640 "count": "string" 2641 }, 2642 "tier_top_bound": { 2643 "number": "string", 2644 "amount": { 2645 "quantity": "string", 2646 "currency": "AED" 2647 }, 2648 "count": "string" 2649 }, 2650 "volume_share": "string", 2651 "included_volume": { 2652 "number": "string", 2653 "amount": { 2654 "quantity": "string", 2655 "currency": "AED" 2656 }, 2657 "count": "string" 2658 } 2659 }, 2660 "meter_value": { 2661 "id": "string", 2662 "reference": "string", 2663 "number": "string", 2664 "amount": { 2665 "quantity": "string", 2666 "currency": "AED" 2667 }, 2668 "count": "string", 2669 "ratio": "string", 2670 "type": "NUMBER" 2671 }, 2672 "tiering_meter_value": { 2673 "id": "string", 2674 "reference": "string", 2675 "number": "string", 2676 "amount": { 2677 "quantity": "string", 2678 "currency": "AED" 2679 }, 2680 "count": "string", 2681 "ratio": "string", 2682 "type": "NUMBER" 2683 }, 2684 "price_bound": "string", 2685 "meter_values": [ 2686 { 2687 "number": "string", 2688 "amount": { 2689 "quantity": "string", 2690 "currency": "AED" 2691 }, 2692 "amount_in_pricing_currency": { 2693 "quantity": "string", 2694 "currency": "AED" 2695 }, 2696 "count": 1, 2697 "ratio": "string" 2698 } 2699 ], 2700 "report_meter_values": [ 2701 { 2702 "meter_value_calculation_id": "string", 2703 "number": "string", 2704 "amount": { 2705 "quantity": "string", 2706 "currency": "AED" 2707 }, 2708 "amount_in_pricing_currency": { 2709 "quantity": "string", 2710 "currency": "AED" 2711 }, 2712 "count": "string", 2713 "ratio": "string" 2714 } 2715 ], 2716 "description": "string", 2717 "used_exchange_rates": [ 2718 { 2719 "currency": "string", 2720 "base_currency": "string", 2721 "rate_timestamp": "string", 2722 "rate": "string", 2723 "source": "string" 2724 } 2725 ], 2726 "included_volume_details": { 2727 "included_volume": { 2728 "id": "string", 2729 "reference": "string", 2730 "number": "string", 2731 "amount": { 2732 "quantity": "string", 2733 "currency": "AED" 2734 }, 2735 "count": "string", 2736 "ratio": "string", 2737 "type": "NUMBER" 2738 }, 2739 "available_included_volume": { 2740 "id": "string", 2741 "reference": "string", 2742 "number": "string", 2743 "amount": { 2744 "quantity": "string", 2745 "currency": "AED" 2746 }, 2747 "count": "string", 2748 "ratio": "string", 2749 "type": "NUMBER" 2750 }, 2751 "period_volume": { 2752 "id": "string", 2753 "reference": "string", 2754 "number": "string", 2755 "amount": { 2756 "quantity": "string", 2757 "currency": "AED" 2758 }, 2759 "count": "string", 2760 "ratio": "string", 2761 "type": "NUMBER" 2762 } 2763 }, 2764 "wallet_balance_details": { 2765 "used_wallet_credits": { 2766 "quantity": "string", 2767 "credit_type_id": "string" 2768 }, 2769 "left_wallet_credits": { 2770 "quantity": "string", 2771 "credit_type_id": "string" 2772 }, 2773 "available_wallet_credits": { 2774 "quantity": "string", 2775 "credit_type_id": "string" 2776 } 2777 }, 2778 "split_pricing": { 2779 "meter_properties": [ 2780 { 2781 "id": "string", 2782 "reference": "string", 2783 "value": "string", 2784 "meter_property": { 2785 "object_type": "string", 2786 "id": "string", 2787 "reference": "string", 2788 "name": "string", 2789 "description": "string", 2790 "status": "DRAFT", 2791 "type": "NUMBER", 2792 "enum_values": [ 2793 "string" 2794 ] 2795 } 2796 } 2797 ] 2798 }, 2799 "meter_value_share_of_total": "string", 2800 "meter_value_share_of_processing_only_customer_total": "string" 2801 }, 2802 "description": "string", 2803 "processing_only_customer_id": "string", 2804 "type": "USAGE_BASED_CONVERSION", 2805 "usage_based_conversion": { 2806 "conditions": { 2807 "name": "string", 2808 "expression": { 2809 "operator": "AND", 2810 "operands": [ 2811 { 2812 "meter_property": { 2813 "id": "string", 2814 "reference": "string", 2815 "meter_property": { 2816 "object_type": "string", 2817 "id": "string", 2818 "reference": "string", 2819 "name": "string", 2820 "description": "string", 2821 "status": "DRAFT", 2822 "type": "NUMBER", 2823 "enum_values": [ 2824 "string" 2825 ] 2826 }, 2827 "value": "string", 2828 "values": [ 2829 "string" 2830 ], 2831 "comparator": "EQUALS" 2832 }, 2833 "expression": {} 2834 } 2835 ] 2836 }, 2837 "meter_properties": [ 2838 { 2839 "id": "string", 2840 "reference": "string", 2841 "meter_property": { 2842 "object_type": "string", 2843 "id": "string", 2844 "reference": "string", 2845 "name": "string", 2846 "description": "string", 2847 "status": "DRAFT", 2848 "type": "NUMBER", 2849 "enum_values": [ 2850 "string" 2851 ] 2852 }, 2853 "value": "string", 2854 "values": [ 2855 "string" 2856 ], 2857 "comparator": "EQUALS" 2858 } 2859 ] 2860 } 2861 }, 2862 "processing_only_customer_resource_id": "string" 2863 } 2864 ] 2865 } 2866 ], 2867 "billing_customer_id": "string" 2868 } 2869 ] 2870 } 2871 ], 2872 "tax_categories": [ 2873 { 2874 "base_amount": { 2875 "quantity": "string", 2876 "currency": "AED" 2877 }, 2878 "tax_amount": { 2879 "quantity": "string", 2880 "currency": "AED" 2881 }, 2882 "total_amount": { 2883 "quantity": "string", 2884 "currency": "AED" 2885 }, 2886 "category": "string", 2887 "local_amounts": { 2888 "base_amount": { 2889 "quantity": "string", 2890 "currency": "AED" 2891 }, 2892 "tax_amount": { 2893 "quantity": "string", 2894 "currency": "AED" 2895 }, 2896 "total_amount": { 2897 "quantity": "string", 2898 "currency": "AED" 2899 }, 2900 "used_exchange_rate": { 2901 "currency": "string", 2902 "base_currency": "string", 2903 "rate_timestamp": "string", 2904 "rate": "string", 2905 "source": "string" 2906 }, 2907 "display": true 2908 }, 2909 "notes": [ 2910 "string" 2911 ], 2912 "rates": [ 2913 { 2914 "name": "string", 2915 "percentage": "string", 2916 "tax_amount": { 2917 "quantity": "string", 2918 "currency": "AED" 2919 } 2920 } 2921 ], 2922 "percentage": "string", 2923 "name": "string" 2924 } 2925 ], 2926 "tax_summary": { 2927 "base_amount": { 2928 "quantity": "string", 2929 "currency": "AED" 2930 }, 2931 "tax_amount": { 2932 "quantity": "string", 2933 "currency": "AED" 2934 }, 2935 "total_amount": { 2936 "quantity": "string", 2937 "currency": "AED" 2938 }, 2939 "local_amounts": { 2940 "base_amount": { 2941 "quantity": "string", 2942 "currency": "AED" 2943 }, 2944 "tax_amount": { 2945 "quantity": "string", 2946 "currency": "AED" 2947 }, 2948 "total_amount": { 2949 "quantity": "string", 2950 "currency": "AED" 2951 }, 2952 "used_exchange_rate": { 2953 "currency": "string", 2954 "base_currency": "string", 2955 "rate_timestamp": "string", 2956 "rate": "string", 2957 "source": "string" 2958 }, 2959 "display": true 2960 }, 2961 "notes": [ 2962 "string" 2963 ], 2964 "country_code": "string" 2965 }, 2966 "dunning_actions": [ 2967 { 2968 "payment_acceptor_id": "string", 2969 "external_reference": "string", 2970 "status": "CANCEL_PENDING", 2971 "failure_reason": "string", 2972 "first_payment_id": "string" 2973 } 2974 ], 2975 "payment_acceptor_ids": [ 2976 "string" 2977 ], 2978 "payment_actions": [ 2979 { 2980 "payment_acceptor_id": "string", 2981 "payment_acceptor": { 2982 "object_type": "string", 2983 "id": "string", 2984 "billing_entity_id": "string", 2985 "customer_id": "string", 2986 "reference": "string", 2987 "name": "string", 2988 "description": "string", 2989 "type": "BANK_ACCOUNT", 2990 "bank_account": { 2991 "type": "IBAN", 2992 "iban": "string", 2993 "country": "string", 2994 "bic": "string", 2995 "bank_name": "string", 2996 "bank_address": { 2997 "line1": "string", 2998 "line2": "string", 2999 "city": "string", 3000 "postal_code": "string", 3001 "state": "string", 3002 "country": "AD" 3003 }, 3004 "account_number_and_bic": { 3005 "account_number": "string", 3006 "bank_code": "string", 3007 "bic": "string" 3008 }, 3009 "uk_local": { 3010 "account_number": "string", 3011 "sort_code": "string" 3012 }, 3013 "us_local": { 3014 "account_number": "string", 3015 "account_type": "CHECKING", 3016 "bank_code": "string", 3017 "routing_number": "string" 3018 }, 3019 "br_local": { 3020 "branch": "string", 3021 "account_number": "string", 3022 "bic": "string" 3023 }, 3024 "ar_local": { 3025 "cbu": "string", 3026 "account_number": "string", 3027 "bic": "string" 3028 }, 3029 "mx_local": { 3030 "clabe": "string", 3031 "account_number": "string", 3032 "bic": "string" 3033 }, 3034 "account_number": "string", 3035 "bank_code": "string", 3036 "routing_number": "string", 3037 "account_type": "CHECKING" 3038 }, 3039 "payment_gateway": { 3040 "integration_id": "string", 3041 "integration": { 3042 "object_type": "string", 3043 "id": "string", 3044 "reference": "string", 3045 "name": "string", 3046 "description": "string", 3047 "status": "DRAFT", 3048 "message": "string", 3049 "type": "PAYMENT_GATEWAY", 3050 "variant": "DEFAULT", 3051 "paragon_settings": { 3052 "paragon_external_id": "string" 3053 }, 3054 "authentication": { 3055 "api_key": { 3056 "header": "string", 3057 "value": "string" 3058 }, 3059 "client_credentials": { 3060 "client_id": "string", 3061 "client_secret": "string" 3062 }, 3063 "username_password": { 3064 "username": "string", 3065 "password": "string" 3066 } 3067 }, 3068 "payment_gateway": { 3069 "variant": "ADYEN", 3070 "adyen": { 3071 "company_account": "string", 3072 "environment": "LIVE", 3073 "live_prefix": "string", 3074 "merchant_accounts": [ 3075 "string" 3076 ], 3077 "public_key": "string", 3078 "signing_secret": "string", 3079 "ownership": "PLATFORM", 3080 "system_ownership_details": { 3081 "account_holder_id": "string", 3082 "balance_account_id": "string", 3083 "legal_entity_id": "string", 3084 "store_id": "string" 3085 }, 3086 "balance_platform_details": { 3087 "account": "string", 3088 "authentication": { 3089 "api_key": { 3090 "header": "string", 3091 "value": "string" 3092 }, 3093 "client_credentials": { 3094 "client_id": "string", 3095 "client_secret": "string" 3096 }, 3097 "username_password": { 3098 "username": "string", 3099 "password": "string" 3100 } 3101 } 3102 }, 3103 "legal_entity_manager_details": { 3104 "authentication": { 3105 "api_key": { 3106 "header": "string", 3107 "value": "string" 3108 }, 3109 "client_credentials": { 3110 "client_id": "string", 3111 "client_secret": "string" 3112 }, 3113 "username_password": { 3114 "username": "string", 3115 "password": "string" 3116 } 3117 } 3118 }, 3119 "enabled_payment_methods": [ 3120 "string" 3121 ] 3122 }, 3123 "stripe": { 3124 "public_key": "string", 3125 "signing_secret": "string" 3126 } 3127 }, 3128 "e_invoicing": { 3129 "mandates": [ 3130 { 3131 "name": "string", 3132 "country": "string", 3133 "mappings": [ 3134 { 3135 "target": "string", 3136 "source": "string", 3137 "description": "string" 3138 } 3139 ], 3140 "condition_groups": [ 3141 { 3142 "conditions": [ 3143 { 3144 "field": "string", 3145 "comparator_type": "EQUALS", 3146 "value": "string" 3147 } 3148 ] 3149 } 3150 ], 3151 "include_pdf_in_einvoice": true, 3152 "supported_file_formats": [ 3153 { 3154 "type": "string", 3155 "description": "string" 3156 } 3157 ] 3158 } 3159 ], 3160 "processor": "AVALARA" 3161 }, 3162 "data_export": { 3163 "variant": "S3", 3164 "s3": { 3165 "bucket_name": "string", 3166 "bucket_path": "string", 3167 "bucket_region": "string", 3168 "authentication_type": "ACCESS_KEY_AND_SECRET", 3169 "role_arn": "string", 3170 "external_id": "string" 3171 }, 3172 "bigquery": { 3173 "project_id": "string", 3174 "dataset_id": "string", 3175 "dataset_location": "string", 3176 "gcs_bucket_name": "string", 3177 "gcs_hmac_key_access_id": "string", 3178 "gcs_hmac_key_secret": "string" 3179 }, 3180 "gcs": { 3181 "bucket_region": "string", 3182 "bucket_name": "string", 3183 "bucket_path": "string", 3184 "flattening": true 3185 }, 3186 "snowflake": { 3187 "host": "string", 3188 "role": "string", 3189 "warehouse": "string", 3190 "database": "string", 3191 "schema": "string" 3192 }, 3193 "transport_type": "string" 3194 }, 3195 "tax_calculation": { 3196 "billing_entity_id": "string", 3197 "variant": "AVATAX", 3198 "ava_tax": { 3199 "company_code": "string" 3200 }, 3201 "custom_tax_codes": [ 3202 { 3203 "field": "INVOICE_COMMITMENT", 3204 "value": "string" 3205 } 3206 ], 3207 "enable_tax_filing": true 3208 }, 3209 "linked_resources_configurations": [ 3210 { 3211 "resource_type": "string", 3212 "link_details": [ 3213 { 3214 "base_url": "string", 3215 "custom_field_reference": "string" 3216 } 3217 ] 3218 } 3219 ], 3220 "email_provider": { 3221 "variant": "SYSTEM", 3222 "mailgun": { 3223 "domain": "string", 3224 "region": "US", 3225 "plan": "string" 3226 }, 3227 "delivery_window": { 3228 "type": "DAY", 3229 "value": 1 3230 } 3231 }, 3232 "erp": { 3233 "variant": "XERO" 3234 } 3235 }, 3236 "store_payment_method": true, 3237 "auto_charge_payment_method": true, 3238 "collection_type": "LINK", 3239 "link": { 3240 "expiry_period": { 3241 "type": "DAY", 3242 "value": 1 3243 } 3244 }, 3245 "adyen": { 3246 "auto_rescue": { 3247 "enabled": true, 3248 "period": { 3249 "type": "DAY", 3250 "value": 1 3251 } 3252 }, 3253 "merchant_account": "string", 3254 "allowed_payment_methods": [ 3255 "string" 3256 ] 3257 } 3258 }, 3259 "custom_redirect": { 3260 "url": "string" 3261 }, 3262 "status": "DRAFT" 3263 }, 3264 "type": "string", 3265 "bank_account": { 3266 "legal_name": "string", 3267 "country_code": "string", 3268 "iban": "string", 3269 "bic": "string", 3270 "bank_name": "string", 3271 "account_number": "string", 3272 "bank_code": "string", 3273 "sort_code": "string", 3274 "reference": "string", 3275 "routing_number": "string", 3276 "account_type": "string", 3277 "type": "string", 3278 "bank_address": { 3279 "line1": "string", 3280 "line2": "string", 3281 "city": "string", 3282 "postal_code": "string", 3283 "state": "string", 3284 "country": "AD" 3285 }, 3286 "branch": "string", 3287 "cbu": "string", 3288 "clabe": "string" 3289 }, 3290 "payment_gateway": { 3291 "variant": "string", 3292 "collection_type": "string", 3293 "adyen": { 3294 "id": "string", 3295 "session_data": "string" 3296 }, 3297 "stripe": { 3298 "payment_intent_id": "string", 3299 "client_secret": "string" 3300 } 3301 }, 3302 "custom_redirect": { 3303 "url": "string" 3304 } 3305 } 3306 ], 3307 "pay_invoice_link": { 3308 "expiry_period": { 3309 "type": "DAY", 3310 "value": 1 3311 }, 3312 "portal_url_id": "string", 3313 "url": "string" 3314 }, 3315 "notes": [ 3316 "string" 3317 ], 3318 "linked_invoices": [ 3319 { 3320 "id": "string", 3321 "link_type": "string", 3322 "note": "string", 3323 "invoice_number": "string", 3324 "amount": { 3325 "quantity": "string", 3326 "currency": "AED" 3327 }, 3328 "invoice_date": "string" 3329 } 3330 ], 3331 "custom_fields": [ 3332 { 3333 "id": "string", 3334 "reference": "string", 3335 "value": "string", 3336 "values": [ 3337 "string" 3338 ], 3339 "integration_details": { 3340 "id": "string", 3341 "reference": "string", 3342 "payment_gateway_variant": "ADYEN", 3343 "adyen": { 3344 "recurring_detail_reference": "string" 3345 }, 3346 "stripe": { 3347 "payment_method_id": "string" 3348 } 3349 }, 3350 "integration_id": "string" 3351 } 3352 ], 3353 "other_custom_fields": [ 3354 { 3355 "resource": { 3356 "type": "PLATFORM", 3357 "id": "string" 3358 }, 3359 "id": "string", 3360 "reference": "string", 3361 "name": "string", 3362 "value": "string", 3363 "values": [ 3364 "string" 3365 ] 3366 } 3367 ], 3368 "credit": { 3369 "original_invoice_info": { 3370 "id": "string", 3371 "invoice_number": "string" 3372 }, 3373 "note": "string", 3374 "credit_details_source": "CURRENT", 3375 "original_invoice_id": "string" 3376 }, 3377 "e_invoices": [ 3378 { 3379 "external_reference": "string", 3380 "applied_mandate": "string", 3381 "processor": "string", 3382 "status": { 3383 "status": "string", 3384 "timestamp": "string", 3385 "message": "string" 3386 }, 3387 "status_history": [ 3388 { 3389 "status": "string", 3390 "timestamp": "string", 3391 "message": "string" 3392 } 3393 ], 3394 "supported_file_formats": [ 3395 { 3396 "type": "string", 3397 "description": "string" 3398 } 3399 ] 3400 } 3401 ], 3402 "used_exchange_rates": [ 3403 { 3404 "currency": "string", 3405 "base_currency": "string", 3406 "rate_timestamp": "string", 3407 "rate": "string", 3408 "source": "string" 3409 } 3410 ], 3411 "processing_only_customers": [ 3412 { 3413 "object_type": "string", 3414 "id": "string", 3415 "created_at": "string", 3416 "parent_customer_id": "string", 3417 "parent_customer_ids": [ 3418 "string" 3419 ], 3420 "reference": "string", 3421 "status": "DRAFT", 3422 "timezone": "string", 3423 "type": "ORGANIZATION", 3424 "email": "string", 3425 "notification_preferences": [ 3426 { 3427 "type": "INVOICE", 3428 "channels": [ 3429 { 3430 "type": "EMAIL", 3431 "enabled": true 3432 } 3433 ] 3434 } 3435 ], 3436 "locale": "string", 3437 "individual": { 3438 "name": { 3439 "first_name": "string", 3440 "last_name": "string", 3441 "infix": "string" 3442 }, 3443 "residential_address": { 3444 "line1": "string", 3445 "line2": "string", 3446 "city": "string", 3447 "postal_code": "string", 3448 "state": "string", 3449 "country": "AD" 3450 } 3451 }, 3452 "organization": { 3453 "legal_name": "string", 3454 "tax_id": "string", 3455 "tax_ids": [ 3456 { 3457 "id": "string", 3458 "type": "GENERIC_TAX_ID", 3459 "display_name": "string", 3460 "tax_id_validation_result": { 3461 "id": "string", 3462 "validation_date": "string", 3463 "source": "string", 3464 "valid": "VALID", 3465 "message": "string" 3466 } 3467 } 3468 ], 3469 "registration_number": "string", 3470 "tax_exempt": true, 3471 "tax_exempt_note": "string", 3472 "registered_address": { 3473 "line1": "string", 3474 "line2": "string", 3475 "city": "string", 3476 "postal_code": "string", 3477 "state": "string", 3478 "country": "AD" 3479 }, 3480 "tax_registrations": [ 3481 { 3482 "id": "string", 3483 "description": "string", 3484 "tax_id": "string", 3485 "tax_ids": [ 3486 { 3487 "id": "string", 3488 "type": "GENERIC_TAX_ID", 3489 "display_name": "string", 3490 "tax_id_validation_result": { 3491 "id": "string", 3492 "validation_date": "string", 3493 "source": "string", 3494 "valid": "VALID", 3495 "message": "string" 3496 } 3497 } 3498 ], 3499 "registration_number": "string", 3500 "registered_address": { 3501 "line1": "string", 3502 "line2": "string", 3503 "city": "string", 3504 "postal_code": "string", 3505 "state": "string", 3506 "country": "AD" 3507 } 3508 } 3509 ] 3510 }, 3511 "custom_fields": [ 3512 { 3513 "id": "string", 3514 "reference": "string", 3515 "value": "string", 3516 "values": [ 3517 "string" 3518 ], 3519 "integration_details": { 3520 "id": "string", 3521 "reference": "string", 3522 "payment_gateway_variant": "ADYEN", 3523 "adyen": { 3524 "recurring_detail_reference": "string" 3525 }, 3526 "stripe": { 3527 "payment_method_id": "string" 3528 } 3529 }, 3530 "integration_id": "string" 3531 } 3532 ], 3533 "pricing_plan_subscription_selector": { 3534 "data": [ 3535 { 3536 "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY", 3537 "value": "string" 3538 } 3539 ], 3540 "rules": [ 3541 { 3542 "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY", 3543 "type": "EQUALS" 3544 } 3545 ], 3546 "filters": [ 3547 { 3548 "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY", 3549 "type": "EQUALS", 3550 "value": "string" 3551 } 3552 ], 3553 "fallback": "LATEST" 3554 }, 3555 "linked_integrations": [ 3556 { 3557 "id": "string", 3558 "link_details": [ 3559 { 3560 "url": "string", 3561 "custom_field_name": "string" 3562 } 3563 ] 3564 } 3565 ], 3566 "roles": [ 3567 "DEFAULT" 3568 ], 3569 "seller_details": { 3570 "default_billing_entity_id": "string" 3571 }, 3572 "processing_only": true 3573 } 3574 ], 3575 "meter_values": [ 3576 { 3577 "object_type": "string", 3578 "id": "string", 3579 "reference": "string", 3580 "name": "string", 3581 "description": "string", 3582 "status": "DRAFT", 3583 "type": "NUMBER" 3584 } 3585 ], 3586 "credit_types": [ 3587 { 3588 "object_type": "string", 3589 "id": "string", 3590 "reference": "string", 3591 "status": "DRAFT", 3592 "name": "string", 3593 "description": "string", 3594 "unit_name": { 3595 "singular": "string", 3596 "plural": "string" 3597 }, 3598 "created_at": "string", 3599 "updated_at": "string" 3600 } 3601 ], 3602 "display_invoice_sub_lines_per_processing_only_customer": true, 3603 "show_tax_per_line_item": true, 3604 "forwarded_from_customers": [ 3605 { 3606 "object_type": "string", 3607 "id": "string", 3608 "created_at": "string", 3609 "parent_customer_id": "string", 3610 "parent_customer_ids": [ 3611 "string" 3612 ], 3613 "reference": "string", 3614 "status": "DRAFT", 3615 "timezone": "string", 3616 "type": "ORGANIZATION", 3617 "email": "string", 3618 "notification_preferences": [ 3619 { 3620 "type": "INVOICE", 3621 "channels": [ 3622 { 3623 "type": "EMAIL", 3624 "enabled": true 3625 } 3626 ] 3627 } 3628 ], 3629 "locale": "string", 3630 "individual": { 3631 "name": { 3632 "first_name": "string", 3633 "last_name": "string", 3634 "infix": "string" 3635 }, 3636 "residential_address": { 3637 "line1": "string", 3638 "line2": "string", 3639 "city": "string", 3640 "postal_code": "string", 3641 "state": "string", 3642 "country": "AD" 3643 } 3644 }, 3645 "organization": { 3646 "legal_name": "string", 3647 "tax_id": "string", 3648 "tax_ids": [ 3649 { 3650 "id": "string", 3651 "type": "GENERIC_TAX_ID", 3652 "display_name": "string", 3653 "tax_id_validation_result": { 3654 "id": "string", 3655 "validation_date": "string", 3656 "source": "string", 3657 "valid": "VALID", 3658 "message": "string" 3659 } 3660 } 3661 ], 3662 "registration_number": "string", 3663 "tax_exempt": true, 3664 "tax_exempt_note": "string", 3665 "registered_address": { 3666 "line1": "string", 3667 "line2": "string", 3668 "city": "string", 3669 "postal_code": "string", 3670 "state": "string", 3671 "country": "AD" 3672 }, 3673 "tax_registrations": [ 3674 { 3675 "id": "string", 3676 "description": "string", 3677 "tax_id": "string", 3678 "tax_ids": [ 3679 { 3680 "id": "string", 3681 "type": "GENERIC_TAX_ID", 3682 "display_name": "string", 3683 "tax_id_validation_result": { 3684 "id": "string", 3685 "validation_date": "string", 3686 "source": "string", 3687 "valid": "VALID", 3688 "message": "string" 3689 } 3690 } 3691 ], 3692 "registration_number": "string", 3693 "registered_address": { 3694 "line1": "string", 3695 "line2": "string", 3696 "city": "string", 3697 "postal_code": "string", 3698 "state": "string", 3699 "country": "AD" 3700 } 3701 } 3702 ] 3703 }, 3704 "custom_fields": [ 3705 { 3706 "id": "string", 3707 "reference": "string", 3708 "value": "string", 3709 "values": [ 3710 "string" 3711 ], 3712 "integration_details": { 3713 "id": "string", 3714 "reference": "string", 3715 "payment_gateway_variant": "ADYEN", 3716 "adyen": { 3717 "recurring_detail_reference": "string" 3718 }, 3719 "stripe": { 3720 "payment_method_id": "string" 3721 } 3722 }, 3723 "integration_id": "string" 3724 } 3725 ], 3726 "pricing_plan_subscription_selector": { 3727 "data": [ 3728 { 3729 "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY", 3730 "value": "string" 3731 } 3732 ], 3733 "rules": [ 3734 { 3735 "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY", 3736 "type": "EQUALS" 3737 } 3738 ], 3739 "filters": [ 3740 { 3741 "field": "BILLING_ENTITY_REGISTERED_ADDRESS_COUNTRY", 3742 "type": "EQUALS", 3743 "value": "string" 3744 } 3745 ], 3746 "fallback": "LATEST" 3747 }, 3748 "linked_integrations": [ 3749 { 3750 "id": "string", 3751 "link_details": [ 3752 { 3753 "url": "string", 3754 "custom_field_name": "string" 3755 } 3756 ] 3757 } 3758 ], 3759 "roles": [ 3760 "DEFAULT" 3761 ], 3762 "seller_details": { 3763 "default_billing_entity_id": "string" 3764 }, 3765 "processing_only": true 3766 } 3767 ], 3768 "validation_result": [ 3769 { 3770 "status": "string", 3771 "details": "string" 3772 } 3773 ], 3774 "reprocess": { 3775 "to_be_reprocessed_at": "string", 3776 "reprocess_status": "string", 3777 "reprocess_id": "string" 3778 }, 3779 "used_tax_registration": { 3780 "id": "string", 3781 "description": "string", 3782 "tax_id": "string", 3783 "tax_ids": [ 3784 { 3785 "id": "string", 3786 "type": "GENERIC_TAX_ID", 3787 "display_name": "string", 3788 "tax_id_validation_result": { 3789 "id": "string", 3790 "validation_date": "string", 3791 "source": "string", 3792 "valid": "VALID", 3793 "message": "string" 3794 } 3795 } 3796 ], 3797 "registration_number": "string", 3798 "registered_address": { 3799 "line1": "string", 3800 "line2": "string", 3801 "city": "string", 3802 "postal_code": "string", 3803 "state": "string", 3804 "country": "AD" 3805 } 3806 }, 3807 "footnote": "string", 3808 "approval_status": "PENDING_REVIEW", 3809 "updated_to_final_at": "string", 3810 "has_usage_based_pricing": true, 3811 "coupons": [ 3812 { 3813 "coupon_id": "string", 3814 "coupon_name": "string" 3815 } 3816 ], 3817 "promotion_codes": [ 3818 { 3819 "promotion_code_details": { 3820 "promotion_code_id": "string", 3821 "code": "string" 3822 }, 3823 "coupon_id": "string" 3824 } 3825 ], 3826 "linked_integrations": [ 3827 { 3828 "id": "string", 3829 "link_details": [ 3830 { 3831 "url": "string", 3832 "custom_field_name": "string" 3833 } 3834 ] 3835 } 3836 ], 3837 "billing_type": "DEFAULT", 3838 "payment_status": "UNPAID", 3839 "paid": true, 3840 "auto_rescues": [ 3841 { 3842 "payment_acceptor_id": "string", 3843 "external_reference": "string", 3844 "status": "CANCEL_PENDING", 3845 "failure_reason": "string", 3846 "first_payment_id": "string" 3847 } 3848 ], 3849 "linked_invoices_ids": [ 3850 "string" 3851 ], 3852 "to_be_reprocessed": true, 3853 "to_be_reprocessed_at": "string" 3854 }
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.
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.