Create an invoice for revenue recovery

post

https://v3.recurly.com/invoices/recovery

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

currency

string

required

length ≤ 3

3-letter ISO 4217 currency code.

due_at

date-time

required

Date invoice was originally due. Must be in the past.

po_number

string

length ≤ 50

This identifies the PO number associated with the subscription.

external_recovery_eligible

boolean

required

Must be set to true to acknowledge that the invoice is eligible for external recovery. Requests with false, omitted, or non-boolean values will be rejected.

account

object

required

line_items

array of objects

required

Line items to include on the invoice. Currency is specified at the root level and must not be included in individual line items.

Line items*

transaction_descriptor_suffix

string

length ≤ 255

Optionally overrides the suffix component of the composed transaction descriptor. If omitted, the suffix is derived from the subscription's plan name or the invoice description, with a Trial prefix on Visa trial conversions. Subject to gateway availability and payment method support.

Responses

201Returns the new invoices.

400Bad request, perhaps invalid JSON?

404Incorrect site ID.

422Invalid parameters, no pending line items, or error running the transaction.

defaultUnexpected error.