RYrye-com
Billing

Create on-demand top-up invoice

Changed on

Request an on-demand top-up invoice.. Requires drawdown billing to be enabled. Only one unpaid top-up invoice is allowed at a time.

post/api/v1/billing/drawdown/topup

Request

  • Base URL
    https://staging.api.rye.com
  • URL
    https://staging.api.rye.com/api/v1/billing/drawdown/topup
  • Auth
    API key in header Authorization

Request body

chargeAutomaticallyboolean

Override whether to automatically charge the invoice. Defaults to the developer's drawdown config value if not specified.

amountSubunitsinteger required

Amount in smallest currency unit (e.g. cents).

Example request

{
  "amountSubunits": 500000
}

Response

Created

urlstring nullable required
status'draft' | 'open' | 'paid' | 'uncollectible' | 'void' | 'unknown' required
idstring required

Example response

{
  "url": "https://invoice.stripe.com/i/acct_xxx/test_xxx",
  "amount": {
    "currencyCode": "USD",
    "amountSubunits": 1500
  },
  "id": "in_abc123"
}

Changes