POST/invoicesrequest, you can create an Invoice in either a
openstate. If you don't provide a value, the default is
POST/invoicesrequest in an
draftstate means you're not yet authorizing Digital River to capture the charge. Because invoices created in this state contain the total taxes, fees, duties, and amounts for the goods rendered, they can be useful for emailing renewal reminders to customers.
voidstate are not payable. If you receive payment from the customer outside of the normal flow (e.g., the customer pays by check) you should void the invoice. This is also a terminal state, which means voided invoices can never transition to another state.
openstate can be voided. If you attempt to void an invoice in any other state, you'll receive a
true. This instructs Digital River to make multiple payment capture attempts over a period of time whose length you can specify using the
collectionPeriodDaysparameter. The default setting is 30 days.
collectionPeriodDays, if one of the internal orders that Digital River generates is able to successfully capture the charge, we move the Invoice into a
paidstate. However, if we're unable to collect payment within this time period, we mark the Invoice as
uncollectibleand emit an
attemptCountattribute. This value can be useful for your analytics.
falsemeans we attempt to collect payment just one-time. In this case,
collectionPeriodDayshas no effect on the billing process. After that one collection attempt, depending on the result, we move the Invoice into either a
uncollectiblestate and then emit the appropriate events.
openstate, it can either become
uncollectible. All of these are terminal states, meaning they can never transition to another state. Invoices that move into a
uncollectiblestate are not payable.
statevalues for a successful Invoice (i.e. the happy path) are