Create invoice ondemand for subscription

post

https://api.frisbii.com/v1/subscription/{handle}/invoice

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

handle

string

required

Subscription handle

Body Params

handle

string

required

length ≥ 1

Per account unique handle for the invoice. Max length 255 with allowable characters [a-zA-Z0-9_.-@]. It is recommended to use a maximum of 20 characters as this will allow for the use of handle as reference on bank statements without truncation.

due

string

Optional due date and time on the form yyyy-MM-dd, yyyyMMdd, yyyy-MM-ddTHH:mm and yyyy-MM-ddTHH:mm:ss from which the invoice is eligible to be collected.

metadata

object

Custom metadata.

instant

boolean

Create and process invoice instantly and leave as either settled or failed. The default is to leave the invoice for automatic processing and potential dunning management as other subscription invoices (default false).

settle

object

Optional settle to perform after creation using a different payment method. If the settle fails the status will be failed if instant or pending if not instant. The due date will be ignored for subscription invoice create.

plan_manual

boolean

Create manually for plan by adding plan product and potential add-ons as order line (default false)

plan_period_from

string

Date and time on the form yyyy-MM-dd, yyyyMMdd, yyyy-MM-ddTHH:mm and yyyy-MM-ddTHH:mm:ss describing the start of the service period for the plan-related order lines. This only takes effect if plan_manual is set.

plan_period_to

string

Date and time on the form yyyy-MM-dd, yyyyMMdd, yyyy-MM-ddTHH:mm and yyyy-MM-ddTHH:mm:ss describing the end of the service period for the plan-related order lines. This only takes effect if plan_manual is set.

add_on_service_periods

object

Optional map of add-on handles with date and time in the form yyyy-MM-dd, yyyyMMdd, yyyy-MM-ddTHH:mm and yyyy-MM-ddTHH:mm:ss describing the start and end of the service period for related order lines. This only takes effect if plan_manual is set.

collect_additional_costs

boolean

Collect pending additional costs and transfer to invoice (default true)

additional_cost_service_periods

object

Optional map of additional cost handles with date and time in the form yyyy-MM-dd, yyyyMMdd, yyyy-MM-ddTHH:mm and yyyy-MM-ddTHH:mm:ss describing the start and end of the service period for related order lines. This only takes effect if plan_manual is set.

collect_credit

boolean

Collect pending credit and transfer to invoice (default true)

apply_discounts

boolean

Apply potential discounts for the subscription to the invoice order lines (default true)

include_unbilled_metered_usage

boolean

Include unbilled usage for the subscription's current billing period (default false)

cost_center

string

Cost center for accounting invoices, overrides the value set for the subscription

po_number

string

Purchase order number for accounting invoices, overrides the value set for the subscription

order_lines

array of objects

length between 0 and 1000

Optional additional order lines for the invoice. A maximum of 100 order lines is allowed.

order_lines

billing_address

object

Optional billing address

shipping_address

object

Optional shipping address

manual_transfer

object

Optional manual transfer. If given the invoice will be settled using the manual transfer transaction.

Responses

200Successful operation

400Invalid request, see error codes at https://api.frisbii.com/v1/error_codes

401None or invalid credentials provided in access to secured resource

403Not authorized to perform resource operation

404Resource or referenced resource not found, see error codes at https://api.frisbii.com/v1/error_codes

429Request limiting exceeded, request rate or concurrent requests, see error code 122 and 123

500Internal service error, error is reported automatically to Frisbii