Billwerk+ is now Frisbii
API Reference
Frisbii WebsiteHelp CenterTry for freeBook a demo
Start typing to search…

Prepare subscription

post https://api.reepay.com/v1/subscription/prepare
Log in to see full request history

Instead of creating a subscription directly, it can be done in a two step process:

  1. Prepare pending subscription. Same as create subscription except for not requiring payment method information.
  2. Activate subscription. Payment method step of create subscription.

A prepared subscription will have state pending and potential invoices will have state created. A prepared subscription will give all details of the subscription including invoices to be paid right away. This can be presented to the customer in an accept phase. The subscription can subsequently be activated with the activate operation.

A subscription in state pending can be deleted completely with the delete pending subscription operation.

Errors

For errors see Create Subscription.

Body Params
string

Customer handle of existing customer. Customer can also be provided in same operation by supplying the parameter create_customer.

string
required

Plan handle

int32
≥ 0

Optional custom per quantity plan price. If provided the plan price billed for each billing period will be overridden by this price.

int32
≥ 1

Optional quantity of the plan product for this subscription. If not provided the default is the default plan quantity defined for the plan.

boolean

Test flag. If given it will be verified that the account state matches the intended create state.

string

Per account unique handle for the subscription. Max length 255 with allowable characters [a-zA-Z0-9_.-@]. Must be provided if generate_handle not defined.

metadata
object

Custom metadata.

create_customer
object

Create customer object

int32
≥ 1

Optional plan version, default is to use newest version of plan

boolean

Whether the optional amount is including VAT. Defaults to true.

boolean

Auto generate handle on the form sub-[sequence_number]

string

Date and time on the form yyyy-MM-dd, yyyyMMdd, yyyy-MM-ddTHH:mm and yyyy-MM-ddTHH:mm:ss from which the subscription is eligible to schedule first invoice. If no time part is given start of day will be used. A start date in the past can be used, but no more than one period length in the past. A start date in the past can result in an instant invoice for a past billing period start. Default value is current date and time.

string

Fixed date and time on the form yyyy-MM-dd, yyyyMMdd, yyyy-MM-ddTHH:mm and yyyy-MM-ddTHH:mm:ss where the subscription will automatically cancel. The subscription will expire at the end of the billing period containing the end date. Default is no fixed end date.

int64
≥ 0

A grace duration in seconds from the creation of a subscription where no dunning process is started for a failing invoice. This allows a certain amount of time for the customer to sign up with a payment method.

boolean

Override plan trial settings and disable trial

boolean

Override plan setup fee settings and disable fee

string

Optional custom trial period overriding the setting on the subscription plan. Defined in ISO 8601 duration. See https://en.wikipedia.org/wiki/ISO_8601#Durations. E.g. P7D for seven days or P1M for one month.

subscription_discounts
array of objects
length between 0 and 100

Discounts to attach to subscription. A maximum of 100 discounts is allowed.

subscription_discounts
coupon_codes
array of strings

Coupon codes to redeem for subscription

coupon_codes
add_ons
array of objects
length between 0 and 100

Add-ons to attach to subscription. The same add-on can only be attached to subscription once unless unique handles are supplied for the subscription add-on. A maximum of 100 add-ons is allowed.

add_ons
additional_costs
array of objects
length between 0 and 100

Additional costs to add to subscription at creation time. A maximum of 100 additional costs is allowed.

additional_costs
additional_entitlements
array of strings

Additional entitlements to add to subscription at creation time.

additional_entitlements
excluded_entitlements
array of strings

Entitlements to exclude from subscription at creation time.

excluded_entitlements
metered_billing_products
array of objects

Metered billing products to attach to subscription.

metered_billing_products
Responses

Response body
object
string
required
length ≥ 1

Per account unique handle for subscription

string
required
length ≥ 1

Customer handle

string
required
length ≥ 1

Subscription plan handle

string
required
length ≥ 1

State of the subscription, one of the following: active, expired, on_hold or pending. Active subscriptions can be cancelled and will expire at the end of the current billing period, or later depending on optional notice and fixation periods, this can be checked using the is_cancelled parameter and expires.

active expired on_hold pending

boolean
required

Test flag

int32

Optional custom plan price. If defined the plan price billed for each billing period will be overridden by this price.

int32
required

Quantity of the plan product for this subscription.

date-time

Fixed date when the subscription will expire because of cancellation. In ISO-8601 extended offset date-time format.

date-time

Date when the subscription was reactivated from on hold. ISO-8601 extended offset date-time format.

string
required
length ≥ 1

Time zone for the subscription as standard time zone id. See Wikipedia

date-time
required

Date when the subscription was created. In ISO-8601 extended offset date-time format.

date-time

Date when the subscription was activated. Will only differ from created in a two step prepared -> activated subscription create scenario. In ISO-8601 extended offset date-time format.

boolean
required

If the subscription renews at current period end. Also true for subscriptions with manual scheduling.

coupons
array of strings

List of coupon handles redeemed for the subscription

coupons
string
required
length ≥ 1

Currency for the subscription in ISO 4217 three letter alpha code

invoices
array of objects

List of created (prepared) invoices for prepared subscription

invoices
object
string
required
length ≥ 1

Invoice id assigned by Frisbii

string
required
length ≥ 1

Per account unique handle. Provided at on-demand invoice/charge creation or set to inv-<invoice_number> for automatically created subscription invoices

string
required
length ≥ 1

Customer handle

string

Subscription handle, will be null for a one-time customer invoice

string

Subscription plan handle for the plan used to automatically create the invoice or the case that an on-demand subscription invoice has been created that should include a plan order line

string
required
length ≥ 1

The invoice state one of the following: created, pending, dunning, settled, cancelled, authorized, failed

created pending dunning settled authorized cancelled failed

boolean

For asynchronous payment methods, e.g. MobilePay subscriptions, this flag indicates that an invoice transaction is in state processing and is awaiting result.

string
required
length ≥ 1

The type of invoice: s - subscription recurring, so - subscription one-time, soi - subscription one-time instant, co - customer one-time, ch - charge

s so soi co ch

int32
required
≥ 0

The invoice amount including VAT

int32
≥ 1

Sequential invoice number. Only present for subscription and customer invoices.

string
required

Invoice currency in ISO 4217 three letter alpha code

date-time
required

When is the invoice due, in ISO-8601 extended offset date-time format.

date-time

When the invoice failed, in ISO-8601 extended offset date-time format.

date-time

When the invoice settled, in ISO-8601 extended offset date-time format.

date-time

When the invoice was cancelled, in ISO-8601 extended offset date-time format.

date-time

When the invoice was authorized, if the invoice went through an authorize and settle flow, in ISO-8601 extended offset date-time format.

credits
array of objects
required

Credits applied to invoice

credits*
object
string
required
length ≥ 1

Credit handle

int32
required
≥ 0

The credit amount transferred to invoice

date-time
required

Date when credit was transferred to invoice. In ISO-8601 extended offset date-time format.

string
required
length ≥ 1

Text describing the credit.

date-time
required

When the invoice was created, in ISO-8601 extended offset date-time format.

int32

Subscription plan version

string

Dunning plan handle

int32
required
≥ 0

The potential discount amount deducted from the invoice amount including VAT

int32
required
≥ 0

The invoice original amount including VAT, may differ from amount if adjustments have been applied for the invoice

int32
required

The invoice vat amount calculated as rounded summed fractional vats for each orderline

int32
required

The invoice amount without vat

int32
required

Settled amount

int32
required

Refunded amount

int32

Authorized amount

int32

Credited amount

int32

The subscription period this invoice is for

string

Optional reference to recurring payment method created in conjunction with charging

order_lines
array of objects
required

Order lines for invoice sorted by descending timestamp

order_lines*
object
string
required
length ≥ 1

Per account unique order line id

string
required
length ≥ 1

Order line text

int32
required

Order line total amount including vat

float
required

Order line vat percent

int32
required
≥ 1

Order line quantity

string
required

Order line origin, one of the following: plan, add_on, ondemand, additional_cost, credit, discount, setup_fee, surcharge_fee, metered_billing_product

plan add_on ondemand additional_cost credit discount setup_fee surcharge_fee metered_billing_product

date-time
required

Timestamp from order line origin, in ISO-8601 extended offset date-time format.

int32

Order line amount after potential discount has been deducted

int32
required

Order line total vat amount

int32
required

Order line total amount without vat

int32
required

Order line unit amount including vat

int32
required

Order line unit vat amount

int32
required

Order line unit amount without vat

boolean
required

Whether the amount was defined including VAT. E.g. plan amount defined including VAT.

string

Tax rule applied for order line indicates who is liable to account for the VAT.

reverse_charge intra_community_digital_service

string

Handle for additional cost, credit, plan or subscription discount in the case one of those are the origin

date-time

The start of billing period if the order line is a plan order line for a specific billing period, in ISO-8601 extended offset date-time format.

date-time

The end of billing period if the order line is a plan order line for a specific billing period, in ISO-8601 extended offset date-time format.

int32

The discount percentage for discount order lines that has a percentage discount

string

For discount order lines a reference to the order line for which the order line is a discount

additional_costs
array of strings
required

Additional cost handles for any additional costs added to this invoice

additional_costs*
transactions
array of objects
required

Invoice transactions, ascending order and limited to 100 transactions

transactions*
object
string
required
length ≥ 1

Transaction id assigned by Frisbii

string
required
length ≥ 1

State of the transaction, one of the following: pending, processing, authorized, settled, refunded, failed, cancelled

pending processing authorized settled refunded failed cancelled

string
required
length ≥ 1

Invoice handle

string
required
length ≥ 1

Transaction type, one of the following: settle, refund, authorization

settle refund authorization

int32
required
≥ 0

The transaction amount

string

Currency in ISO 4217 three letter alpha code

date-time

When the transaction was settled, in ISO-8601 extended offset date-time format.

date-time

When the transaction was authorized, in ISO-8601 extended offset date-time format.

date-time

When the transaction failed, in ISO-8601 extended offset date-time format.

date-time

When the transaction was refunded, in ISO-8601 extended offset date-time format.

date-time
required

Date when the transaction was created. In ISO-8601 extended offset date-time format.

string
required

Payment type for transaction, either: card, mpo, mobilepay, vipps, vipps_epayment, vipps_recurring, swish, viabill, anyday, manual, applepay, googlepay, paypal, klarna_pay_now, klarna_pay_later, klarna_slice_it, klarna_direct_bank_transfer, klarna_direct_debit, resurs, mobilepay_subscriptions, emv_token, bancomatpay, bcmc, blik, pp_blik_oc, giropay, ideal, p24, sepa, trustly, eps, estonia_banks, latvia_banks, lithuania_banks, mb_way, multibanco, mybank, payconiq, paysafecard, paysera, postfinance, satispay, twint, wechatpay, santander, verkkopankki, offline_cash, offline_bank_transfer, or offline_other

card mpo mobilepay vipps vipps_epayment vipps_recurring swish viabill anyday manual applepay googlepay paypal klarna_pay_now klarna_pay_later klarna_slice_it klarna_direct_bank_transfer klarna_direct_debit resurs ideal p24 bancomatpay blik giropay sepa verkkopankki mobilepay_subscriptions emv_token bcmc pp_blik_oc trustly eps estonia_banks latvia_banks lithuania_banks mb_way multibanco mybank payconiq paysafecard paysera postfinance satispay twint wechatpay santander offline_cash offline_bank_transfer offline_other

string

Reference to payment method in case of a MIT transaction

card_transaction
object

Specifics in case of GooglePay transaction

mpo_transaction
object

Specifics in case of GooglePay transaction

vipps_transaction
object

Specifics in case of GooglePay transaction

applepay_transaction
object

Specifics in case of GooglePay transaction

googlepay_transaction
object

Specifics in case of GooglePay transaction

manual_transaction
object

Specifics in case of manual transaction

viabill_transaction
object

Specifics in case of ViaBill transaction

anyday_transaction
object

Specifics in case of Anyday transaction

santander_transaction
object

Specifics in case of Santander transaction

resurs_transaction
object

Specifics in case of Resurs Bank transaction

klarna_transaction
object

Specifics in case of Klarna transaction

swish_transaction
object

Specifics in case of Swish transaction

paypal_transaction
object

Specifics in case of PayPal transaction

bancomatpay_transaction
object

Specifics in case of Bancomat Pay transaction

bancontact_transaction
object

Specifics in case of Bancontact transaction

blik_transaction
object

Specifics in case of BLIK transaction

giropay_transaction
object

Specifics in case of Giropay transaction

ideal_transaction
object

Specifics in case of IDEAL transaction

p24_transaction
object

Specifics in case of P24 transaction

sepa_transaction
object

Specifics in case of SEPA transaction

trustly_transaction
object

Specifics in case of Trustly transaction

verkkopankki_transaction
object

Specifics in case of Verkkopankki transaction

eps_transaction
object

Specifics in case of Eps transaction

estonia_banks_transaction
object

Specifics in case of Estonia Banks transaction

latvia_banks_transaction
object

Specifics in case of Latvia Banks transaction

lithuania_banks_transaction
object

Specifics in case of Lithuania Banks transaction

mbway_transaction
object

Specifics in case of MB Way transaction

multibanco_transaction
object

Specifics in case of Multibanco transaction

mybank_transaction
object

Specifics in case of MyBank transaction

payconiq_transaction
object

Specifics in case of Payconiq transaction

paysafecard_transaction
object

Specifics in case of Paysafecard transaction

paysera_transaction
object

Specifics in case of Paysera transaction

postfinance_transaction
object

Specifics in case of PostFinance transaction

satispay_transaction
object

Specifics in case of Satispay transaction

twint_transaction
object

Specifics in case of Twint transaction

wechatpay_transaction
object

Specifics in case of WeChat Pay transaction

mps_transaction
object

Specifics in case of MobilePay Subscriptions transaction

vipps_epayment_transaction
object

Specifics in case of Vipps ePayments transaction

vipps_recurring_transaction
object

Specifics in case of Vipps Recurring transaction

offline_transaction
object

Specifics in case of Offline transaction

string

Payment context describing if the transaction is customer or merchant initiated, one of the following values: cit, mit, cit_cof

string

Accounting invoice number if this transaction belongs to an accounting invoice

int64

Customer debtor id if this transaction belongs to an accounting invoice

string

Customer handle if this transaction belongs to an accounting invoice

date-time

When dunning for the invoice was started, in ISO-8601 extended offset date-time format.

int32

Number of dunning events for invoice (number of reminders sent)

date-time

When dunning for the invoice expired, in ISO-8601 extended offset date-time format.

date-time

The start of billing period if the invoice is for a specific billing period, in ISO-8601 extended offset date-time format.

date-time

The end of billing period if the invoice is for a specific billing period, in ISO-8601 extended offset date-time format.

boolean

Whether this is a customer one-time invoice that will be settled later

string

The payment method to use for a later settle of a one-time customer invoice

billing_address
object

Optional billing address

shipping_address
object

Optional shipping address

string

Invoice accounting number

int64

Customer debtor id

string

Url to invoice pdf

date-time

When the accounting invoice was created. An accounting invoice is created when a non-charging invoice is created with the state pending or the invoice moved from state created. Timestamp in ISO-8601 extended offset date-time format.

credit_notes
array of objects

Invoice credit notes

credit_notes
object
string
required
length ≥ 1

Credit note id

string
required

Invoice credited by this note

string

Refund transaction id if credit note has an associated refund

string

Credit reference if the credit note relates to a subscription credit

int32
required

Credit note amount

date-time
required

Creation date for note, in ISO-8601 extended offset date-time format.

string
required

Credit note currency in ISO 4217 three letter alpha code

string
required
length ≥ 1

Customer handle

string

Subscription handle, will be null for a one-time customer invoice

int32
required

Credit note vat amount calculated as rounded summed fractional vats for each credit note lines

int32

Credit note total amount excluding VAT calculated as summed amounts excl. vats for each credit note lines

credit_note_lines
array of objects
required

Credit note lines

credit_note_lines*
object
int32
required
≥ 1

Credit note line total amount

string
required
length ≥ 1

Credit note line text

string

Order line description

int32
required
≥ 1

Credit note line quantity

float

Vat for this credit note line

date-time

Creation date for this credit note line, in ISO-8601 extended offset date-time format.

string

Order line origin, one of the following: plan, add_on, ondemand, additional_cost, credit, discount, setup_fee, surcharge_fee, metered_billing_product

plan add_on ondemand additional_cost credit discount setup_fee surcharge_fee metered_billing_product

string

Reference to invoice orderline this credit note line relates to

int32

Credit note line total amount including VAT

int32

Credit note line total amount excluding VAT

int32

Credit note line unit amount

int32

Credit note line vat amount

int32

Credit note line unit amount excluding VAT

boolean

Whether the total and units are including VAT.

date-time

The start of billing period in ISO-8601 extended offset date-time format.

date-time

The end of billing period in ISO-8601 extended offset date-time format.

string

Credit note accounting number

int64

Customer debtor id

string

Url to credit note pdf

date-time

When the credit note was created. A credit note is created when a non-charging invoice is cancelled or refunded. Timestamp in ISO-8601 extended offset date-time format.

int32
required

Subscription plan version

boolean

If optional custom plan price this parameter tells whether the amount is including VAT

date-time
required

Date and time from which the subscription is eligible to schedule invoices. Either from create or from the latest reactivate or subscription change. In ISO-8601 extended offset date-time format.

date-time

Fixed end date and time. In ISO-8601 extended offset date-time format.

int64

Grace duration in seconds from the creation of a subscription where no dunning process is started for a failing invoice. This allows a certain amount of time for the customer to sign up with a payment method.

date-time

Start date and time for the current billing period. In ISO-8601 extended offset date-time format.

date-time

Start date and time for the next billing period, and also end date and time for the current billing period. Is also the date and time for next invoice if the subscription is renewing. In ISO-8601 extended offset date-time format.

date-time

Start date and time for the first ever billing period. In ISO-8601 extended offset date-time format.

date-time

Start date and time for the previous billing period. In ISO-8601 extended offset date-time format.

date-time

Start date and time of free trial period. In ISO-8601 extended offset date-time format.

date-time

End date and time of free trial period. In ISO-8601 extended offset date-time format.

boolean
required

Whether the subscription has been cancelled. Cancelled subscriptions will expire at the end of the current billing period.

boolean
required

Whether the subscription is in its trial period, or if the subscription will start a trial period at a start date in the future. See has_started to determine if the actual trial period has started or not.

boolean
required

If subscription has a later start date, this parameter tells if the subscription has started. Use this in connection with state to determine if a subscription is active.

int32
required
≥ 0

Number of renewals for the subscription (number of invoices)

date-time

Date when the subscription was cancelled. In ISO-8601 extended offset date-time format.

date-time

Date when the subscription expired. ISO-8601 extended offset date-time format.

string

Reason for expire. Can be ondemand, cancelled, dunning or fixed

dunning cancelled ondemand fixed

date-time

Date when the subscription was put on hold. ISO-8601 extended offset date-time format.

string

Reason for on hold. Can be ondemand or dunning

dunning ondemand

boolean
required

Whether the customer at some point has added payment information to the subscription

string

Deprecated - see pending_change. If set, a subscription plan change has been scheduled to follow the next renewal. The value is the subscription plan handle to update to.

date-time

If defined the date a reminder email was sent for the current billing period. In ISO-8601 extended offset date-time format.

int32
required

Number of failed invoices for this subscription

int64
required

Summed amount for failed invoices

int32
required

Number of cancelled invoices for this subscription

int64
required

Summed amount for cancelled invoices

int32
required

Number of pending invoices for this subscription

int64
required

Summed amount for pending invoices

int32
required

Number of dunning invoices for this subscription

int64
required

Summed amount for dunning invoices

int32
required

Number of settled invoices for this subscription

int64
required

Summed settled amount

int64
required

Summed refunded amount

int32
required

Number of pending additional costs

int64
required

Summed amount of pending additional costs incl vat

int32
required

Number of additional costs that have been applied to invoices

int64
required

Summed amount of additional costs that have been applied to invoices

int32
required

Number of credits that have not fully been applied to invoices

int64
required

Summed credit amount not yet applied to invoices

int32
required

Number of credits that have fully been applied to invoices

int64
required

Summed credit amount that have been applied to invoices

hosted_page_links
object
required

Links to hosted pages relating to subscription

string
required
length ≥ 1

Hosted page for setting payment information on subscription. Optional arguments accept_url and cancel_url can be added as query parameters to the URL to have the hosted page redirect after success or cancellation, respectively.

subscription_discounts
array of strings

List of subscription discounts handles attached to subscription

subscription_discounts
pending_change
object

List of subscription changes both at most one pending and previously applied

string

The handle of the plan to change to

int32
≥ 0

Optional custom per quantity plan price. If provided the plan price billed for each billing period will be overridden by this price.

int32
≥ 1

Optional quantity of the plan product for this subscription. If not provided the default is the default plan quantity defined for the plan.

boolean
required

Whether this is a pending change at next renewal, or it has been applied

date-time

If defined the change was applied on this date and time

date-time

Date and time of update of pending change

date-time
required

Date when the change was created. In ISO-8601 extended offset date-time format.

boolean

Whether the optional amount is including VAT. Defaults to true.

subscription_add_ons
array of objects

List of subscription add-ons to create in change

subscription_add_ons
object
string
required
length ≥ 1

Per subscription unique handle for the subscription add-on.

int32
≥ 1

Quantity of the subscription add-on. Only defined for quantity type add-ons

int32

Fixed subscription add-on per quantity price. If not defined the subscription add-on uses the add-on price.

string

Optional name overriding the add-on name. If not defined the add-on name will be used as order line text.

string

Optional description overriding the add-on description. If not defined the add-on description will be used.

date-time
required

Date when the subscription add-on was created. In ISO-8601 extended offset date-time format.

add_on
object
required

Add-on for subscription add-on

boolean

If fixed price this parameter tells whether the amount is including VAT

remove_add_ons
array of strings

Subscription add-ons to remove from subscription by subscription add-on handle

remove_add_ons
subscription_changes
array of objects

List of subscription changes both at most one pending and previously applied

subscription_changes
object
string

The handle of the plan to change to

int32
≥ 0

Optional custom per quantity plan price. If provided the plan price billed for each billing period will be overridden by this price.

int32
≥ 1

Optional quantity of the plan product for this subscription. If not provided the default is the default plan quantity defined for the plan.

boolean
required

Whether this is a pending change at next renewal, or it has been applied

date-time

If defined the change was applied on this date and time

date-time

Date and time of update of pending change

date-time
required

Date when the change was created. In ISO-8601 extended offset date-time format.

boolean

Whether the optional amount is including VAT. Defaults to true.

subscription_add_ons
array of objects

List of subscription add-ons to create in change

subscription_add_ons
object
string
required
length ≥ 1

Per subscription unique handle for the subscription add-on.

int32
≥ 1

Quantity of the subscription add-on. Only defined for quantity type add-ons

int32

Fixed subscription add-on per quantity price. If not defined the subscription add-on uses the add-on price.

string

Optional name overriding the add-on name. If not defined the add-on name will be used as order line text.

string

Optional description overriding the add-on description. If not defined the add-on description will be used.

date-time
required

Date when the subscription add-on was created. In ISO-8601 extended offset date-time format.

add_on
object
required

Add-on for subscription add-on

boolean

If fixed price this parameter tells whether the amount is including VAT

remove_add_ons
array of strings

Subscription add-ons to remove from subscription by subscription add-on handle

remove_add_ons
subscription_add_ons
array of strings

List of subscription add-on handles attached to subscription

subscription_add_ons
active_payment_methods
array of strings

A list of active payment method ids. This list will at most contain 1 item.

active_payment_methods
metered_billing_products
array of strings

List of metered billing products attached to the subscription

metered_billing_products
next_invoice
object

Next invoice preview

string
required
length ≥ 1

Invoice id assigned by Frisbii

string
required
length ≥ 1

Per account unique handle. Provided at on-demand invoice/charge creation or set to inv-<invoice_number> for automatically created subscription invoices

string
required
length ≥ 1

Customer handle

string

Subscription handle, will be null for a one-time customer invoice

string

Subscription plan handle for the plan used to automatically create the invoice or the case that an on-demand subscription invoice has been created that should include a plan order line

string
required
length ≥ 1

The invoice state one of the following: created, pending, dunning, settled, cancelled, authorized, failed

created pending dunning settled authorized cancelled failed

boolean

For asynchronous payment methods, e.g. MobilePay subscriptions, this flag indicates that an invoice transaction is in state processing and is awaiting result.

string
required
length ≥ 1

The type of invoice: s - subscription recurring, so - subscription one-time, soi - subscription one-time instant, co - customer one-time, ch - charge

s so soi co ch

int32
required
≥ 0

The invoice amount including VAT

int32
≥ 1

Sequential invoice number. Only present for subscription and customer invoices.

string
required

Invoice currency in ISO 4217 three letter alpha code

date-time
required

When is the invoice due, in ISO-8601 extended offset date-time format.

date-time

When the invoice failed, in ISO-8601 extended offset date-time format.

date-time

When the invoice settled, in ISO-8601 extended offset date-time format.

date-time

When the invoice was cancelled, in ISO-8601 extended offset date-time format.

date-time

When the invoice was authorized, if the invoice went through an authorize and settle flow, in ISO-8601 extended offset date-time format.

credits
array of objects
required

Credits applied to invoice

credits*
object
string
required
length ≥ 1

Credit handle

int32
required
≥ 0

The credit amount transferred to invoice

date-time
required

Date when credit was transferred to invoice. In ISO-8601 extended offset date-time format.

string
required
length ≥ 1

Text describing the credit.

date-time
required

When the invoice was created, in ISO-8601 extended offset date-time format.

int32

Subscription plan version

string

Dunning plan handle

int32
required
≥ 0

The potential discount amount deducted from the invoice amount including VAT

int32
required
≥ 0

The invoice original amount including VAT, may differ from amount if adjustments have been applied for the invoice

int32
required

The invoice vat amount calculated as rounded summed fractional vats for each orderline

int32
required

The invoice amount without vat

int32
required

Settled amount

int32
required

Refunded amount

int32

Authorized amount

int32

Credited amount

int32

The subscription period this invoice is for

string

Optional reference to recurring payment method created in conjunction with charging

order_lines
array of objects
required

Order lines for invoice sorted by descending timestamp

order_lines*
object
string
required
length ≥ 1

Per account unique order line id

string
required
length ≥ 1

Order line text

int32
required

Order line total amount including vat

float
required

Order line vat percent

int32
required
≥ 1

Order line quantity

string
required

Order line origin, one of the following: plan, add_on, ondemand, additional_cost, credit, discount, setup_fee, surcharge_fee, metered_billing_product

plan add_on ondemand additional_cost credit discount setup_fee surcharge_fee metered_billing_product

date-time
required

Timestamp from order line origin, in ISO-8601 extended offset date-time format.

int32

Order line amount after potential discount has been deducted

int32
required

Order line total vat amount

int32
required

Order line total amount without vat

int32
required

Order line unit amount including vat

int32
required

Order line unit vat amount

int32
required

Order line unit amount without vat

boolean
required

Whether the amount was defined including VAT. E.g. plan amount defined including VAT.

string

Tax rule applied for order line indicates who is liable to account for the VAT.

reverse_charge intra_community_digital_service

string

Handle for additional cost, credit, plan or subscription discount in the case one of those are the origin

date-time

The start of billing period if the order line is a plan order line for a specific billing period, in ISO-8601 extended offset date-time format.

date-time

The end of billing period if the order line is a plan order line for a specific billing period, in ISO-8601 extended offset date-time format.

int32

The discount percentage for discount order lines that has a percentage discount

string

For discount order lines a reference to the order line for which the order line is a discount

additional_costs
array of strings
required

Additional cost handles for any additional costs added to this invoice

additional_costs*
transactions
array of objects
required

Invoice transactions, ascending order and limited to 100 transactions

transactions*
object
string
required
length ≥ 1

Transaction id assigned by Frisbii

string
required
length ≥ 1

State of the transaction, one of the following: pending, processing, authorized, settled, refunded, failed, cancelled

pending processing authorized settled refunded failed cancelled

string
required
length ≥ 1

Invoice handle

string
required
length ≥ 1

Transaction type, one of the following: settle, refund, authorization

settle refund authorization

int32
required
≥ 0

The transaction amount

string

Currency in ISO 4217 three letter alpha code

date-time

When the transaction was settled, in ISO-8601 extended offset date-time format.

date-time

When the transaction was authorized, in ISO-8601 extended offset date-time format.

date-time

When the transaction failed, in ISO-8601 extended offset date-time format.

date-time

When the transaction was refunded, in ISO-8601 extended offset date-time format.

date-time
required

Date when the transaction was created. In ISO-8601 extended offset date-time format.

string
required

Payment type for transaction, either: card, mpo, mobilepay, vipps, vipps_epayment, vipps_recurring, swish, viabill, anyday, manual, applepay, googlepay, paypal, klarna_pay_now, klarna_pay_later, klarna_slice_it, klarna_direct_bank_transfer, klarna_direct_debit, resurs, mobilepay_subscriptions, emv_token, bancomatpay, bcmc, blik, pp_blik_oc, giropay, ideal, p24, sepa, trustly, eps, estonia_banks, latvia_banks, lithuania_banks, mb_way, multibanco, mybank, payconiq, paysafecard, paysera, postfinance, satispay, twint, wechatpay, santander, verkkopankki, offline_cash, offline_bank_transfer, or offline_other

card mpo mobilepay vipps vipps_epayment vipps_recurring swish viabill anyday manual applepay googlepay paypal klarna_pay_now klarna_pay_later klarna_slice_it klarna_direct_bank_transfer klarna_direct_debit resurs ideal p24 bancomatpay blik giropay sepa verkkopankki mobilepay_subscriptions emv_token bcmc pp_blik_oc trustly eps estonia_banks latvia_banks lithuania_banks mb_way multibanco mybank payconiq paysafecard paysera postfinance satispay twint wechatpay santander offline_cash offline_bank_transfer offline_other

string

Reference to payment method in case of a MIT transaction

card_transaction
object

Specifics in case of GooglePay transaction

mpo_transaction
object

Specifics in case of GooglePay transaction

vipps_transaction
object

Specifics in case of GooglePay transaction

applepay_transaction
object

Specifics in case of GooglePay transaction

googlepay_transaction
object

Specifics in case of GooglePay transaction

manual_transaction
object

Specifics in case of manual transaction

viabill_transaction
object

Specifics in case of ViaBill transaction

anyday_transaction
object

Specifics in case of Anyday transaction

santander_transaction
object

Specifics in case of Santander transaction

resurs_transaction
object

Specifics in case of Resurs Bank transaction

klarna_transaction
object

Specifics in case of Klarna transaction

swish_transaction
object

Specifics in case of Swish transaction

paypal_transaction
object

Specifics in case of PayPal transaction

bancomatpay_transaction
object

Specifics in case of Bancomat Pay transaction

bancontact_transaction
object

Specifics in case of Bancontact transaction

blik_transaction
object

Specifics in case of BLIK transaction

giropay_transaction
object

Specifics in case of Giropay transaction

ideal_transaction
object

Specifics in case of IDEAL transaction

p24_transaction
object

Specifics in case of P24 transaction

sepa_transaction
object

Specifics in case of SEPA transaction

trustly_transaction
object

Specifics in case of Trustly transaction

verkkopankki_transaction
object

Specifics in case of Verkkopankki transaction

eps_transaction
object

Specifics in case of Eps transaction

estonia_banks_transaction
object

Specifics in case of Estonia Banks transaction

latvia_banks_transaction
object

Specifics in case of Latvia Banks transaction

lithuania_banks_transaction
object

Specifics in case of Lithuania Banks transaction

mbway_transaction
object

Specifics in case of MB Way transaction

multibanco_transaction
object

Specifics in case of Multibanco transaction

mybank_transaction
object

Specifics in case of MyBank transaction

payconiq_transaction
object

Specifics in case of Payconiq transaction

paysafecard_transaction
object

Specifics in case of Paysafecard transaction

paysera_transaction
object

Specifics in case of Paysera transaction

postfinance_transaction
object

Specifics in case of PostFinance transaction

satispay_transaction
object

Specifics in case of Satispay transaction

twint_transaction
object

Specifics in case of Twint transaction

wechatpay_transaction
object

Specifics in case of WeChat Pay transaction

mps_transaction
object

Specifics in case of MobilePay Subscriptions transaction

vipps_epayment_transaction
object

Specifics in case of Vipps ePayments transaction

vipps_recurring_transaction
object

Specifics in case of Vipps Recurring transaction

offline_transaction
object

Specifics in case of Offline transaction

string

Payment context describing if the transaction is customer or merchant initiated, one of the following values: cit, mit, cit_cof

string

Accounting invoice number if this transaction belongs to an accounting invoice

int64

Customer debtor id if this transaction belongs to an accounting invoice

string

Customer handle if this transaction belongs to an accounting invoice

date-time

When dunning for the invoice was started, in ISO-8601 extended offset date-time format.

int32

Number of dunning events for invoice (number of reminders sent)

date-time

When dunning for the invoice expired, in ISO-8601 extended offset date-time format.

date-time

The start of billing period if the invoice is for a specific billing period, in ISO-8601 extended offset date-time format.

date-time

The end of billing period if the invoice is for a specific billing period, in ISO-8601 extended offset date-time format.

boolean

Whether this is a customer one-time invoice that will be settled later

string

The payment method to use for a later settle of a one-time customer invoice

billing_address
object

Optional billing address

shipping_address
object

Optional shipping address

string

Invoice accounting number

int64

Customer debtor id

string

Url to invoice pdf

date-time

When the accounting invoice was created. An accounting invoice is created when a non-charging invoice is created with the state pending or the invoice moved from state created. Timestamp in ISO-8601 extended offset date-time format.

credit_notes
array of objects

Invoice credit notes

credit_notes
object
string
required
length ≥ 1

Credit note id

string
required

Invoice credited by this note

string

Refund transaction id if credit note has an associated refund

string

Credit reference if the credit note relates to a subscription credit

int32
required

Credit note amount

date-time
required

Creation date for note, in ISO-8601 extended offset date-time format.

string
required

Credit note currency in ISO 4217 three letter alpha code

string
required
length ≥ 1

Customer handle

string

Subscription handle, will be null for a one-time customer invoice

int32
required

Credit note vat amount calculated as rounded summed fractional vats for each credit note lines

int32

Credit note total amount excluding VAT calculated as summed amounts excl. vats for each credit note lines

credit_note_lines
array of objects
required

Credit note lines

credit_note_lines*
object
int32
required
≥ 1

Credit note line total amount

string
required
length ≥ 1

Credit note line text

string

Order line description

int32
required
≥ 1

Credit note line quantity

float

Vat for this credit note line

date-time

Creation date for this credit note line, in ISO-8601 extended offset date-time format.

string

Order line origin, one of the following: plan, add_on, ondemand, additional_cost, credit, discount, setup_fee, surcharge_fee, metered_billing_product

plan add_on ondemand additional_cost credit discount setup_fee surcharge_fee metered_billing_product

string

Reference to invoice orderline this credit note line relates to

int32

Credit note line total amount including VAT

int32

Credit note line total amount excluding VAT

int32

Credit note line unit amount

int32

Credit note line vat amount

int32

Credit note line unit amount excluding VAT

boolean

Whether the total and units are including VAT.

date-time

The start of billing period in ISO-8601 extended offset date-time format.

date-time

The end of billing period in ISO-8601 extended offset date-time format.

string

Credit note accounting number

int64

Customer debtor id

string

Url to credit note pdf

date-time

When the credit note was created. A credit note is created when a non-charging invoice is cancelled or refunded. Timestamp in ISO-8601 extended offset date-time format.

Updated about 11 hours ago

Did this page help you?
Language
Credentials
:

Updated about 11 hours ago

Did this page help you?