--- title: "Create Swish session" method: POST path: "/v1/checkout/{id}/swish" tags: ["checkout"] --- # Create Swish session `POST /v1/checkout/{id}/swish` ## Request - Base URL: `https://checkout-api.frisbii.com` - URL: `https://checkout-api.frisbii.com/v1/checkout/{id}/swish` - Auth: none declared ## Path parameters - `id` string, required ## Request body - CreateSwishSession - `phone` string ## Response `200` Successful operation - CheckoutSession - `id` string, required: Session id - `type` 'CHARGE' | 'RECURRING' | 'SUBSCRIPTION', required: Session type - `result` 'SUCCESS' | 'SESSION_DELETED' | 'SESSION_EXPIRED' | 'CHARGE_FAILURE' | 'CHARGE_CARD_TOKEN_EXPIRED' | 'NO_PAYMENT_METHODS' | 'REEPAY_ERROR' | 'CAPACITY_ERROR' | 'INTERNAL_ERROR' | 'INVOICE_ALREADY_PAID' | 'INVOICE_CANCELLED' | 'INVOICE_PROCESSING' | 'PAYMENT_METHOD_ALREADY_ADDED' - `errorCode` integer - `errorMessage` string - `pproError` PproError - `transactionState` 'PENDING' | 'ACCEPTED' | 'SOFT_DECLINED' | 'HARD_DECLINED' | 'PROCESSING_ERROR' - `transactionError` 'CREDIT_CARD_EXPIRED' | 'INSUFFICIENT_FUNDS' | 'DECLINED_BY_ACQUIRER' | 'ACQUIRER_COMMUNICATION_ERROR' | 'ACQUIRER_ERROR' | 'ACQUIRER_INTEGRATION_ERROR' | 'ACQUIRER_AUTHENTICATION_ERROR' | 'ACQUIRER_CONFIGURATION_ERROR' | 'ACQUIRER_REJECTED_ERROR' | 'CARD_IDENTIFIER_NOT_FOUND' | 'REFUND_AMOUNT_TOO_HIGH' | 'CREDIT_CARD_LOST_OR_STOLEN' | 'CREDIT_CARD_SUSPECTED_FRAUD' | 'AUTHORIZATION_EXPIRED' | 'AUTHORIZATION_AMOUNT_EXCEEDED' | 'AUTHORIZATION_VOIDED' | 'SETTLE_BLOCKED' | 'SCA_REQUIRED' | 'RISK_FILTER_BLOCK' | 'FRAUD_BLOCK' | 'EMV_TOKEN_DELETED' | 'EMV_TOKEN_SUSPENDED' - `logo` string - `configuration` string - `styleConfig` StyleConfig: Optional style configuration - `backgroundColor` string - `windowBackgroundColor` string - `windowHeaderBackgroundColor` string - `paymentHeaderBackgroundColor` string - `footerBackgroundColor` string - `darkMode` boolean - `windowHeaderBoxShadowColor` string - `footerFont` FontConfig - `color` string - `family` string - `size` string - `weight` integer - `sizeMobile` string - `weightMobile` integer - `footerLogoColor` 'grey' | 'black' | 'blue' | 'white': Frisbii logo colour in the checkout footer. Defaults to grey. - `windowHeaderCancelButton` FontConfig - `color` string - `family` string - `size` string - `weight` integer - `sizeMobile` string - `weightMobile` integer - `defaultConfig` DefaultConfig - `font` FontConfig - `color` string - `family` string - `size` string - `weight` integer - `sizeMobile` string - `weightMobile` integer - `border` BorderTypeConfig - `standard` BorderConfig - `width` string - `color` string - `radius` string - `focused` BorderConfig - `width` string - `color` string - `radius` string - `valid` BorderConfig - `width` string - `color` string - `radius` string - `invalid` BorderConfig - `width` string - `color` string - `radius` string - `buttonConfig` ButtonConfig - `payButtonSpacing` SpacingConfig - `padding` PaddingConfig - `top` string - `bottom` string - `right` string - `left` string - `margin` MarginConfig - `top` string - `bottom` string - `right` string - `left` string - `continueButtonSpacing` SpacingConfig - `padding` PaddingConfig - `top` string - `bottom` string - `right` string - `left` string - `margin` MarginConfig - `top` string - `bottom` string - `right` string - `left` string - `payButtonBorder` BorderConfig - `width` string - `color` string - `radius` string - `continueButtonBorder` BorderConfig - `width` string - `color` string - `radius` string - `paymentMethodDivider` PaymentMethodDividerConfig - `color` string - `topColor` string - `bottomColor` string - `paymentMethodTitle` PaymentMethodTitleConfig - `standard` FontConfig - `color` string - `family` string - `size` string - `weight` integer - `sizeMobile` string - `weightMobile` integer - `selected` FontConfig - `color` string - `family` string - `size` string - `weight` integer - `sizeMobile` string - `weightMobile` integer - `coBrandedCardSelection` CoBrandedCardSelectionConfig - `font` FontConfig - `color` string - `family` string - `size` string - `weight` integer - `sizeMobile` string - `weightMobile` integer - `radioButtonGroup` RadioButtonGroupConfig - `font` FontConfig - `color` string - `family` string - `size` string - `weight` integer - `sizeMobile` string - `weightMobile` integer - `unchecked` RadioButtonConfig - `fontWeight` integer - `fontWeightMobile` integer - `indicatorSize` string - `indicatorSizeMobile` string - `indicatorColor` string - `checked` RadioButtonConfig - `fontWeight` integer - `fontWeightMobile` integer - `indicatorSize` string - `indicatorSizeMobile` string - `indicatorColor` string - `paymentDescription` FontConfig - `color` string - `family` string - `size` string - `weight` integer - `sizeMobile` string - `weightMobile` integer - `paymentAmount` FontConfig - `color` string - `family` string - `size` string - `weight` integer - `sizeMobile` string - `weightMobile` integer - `labels` FontConfig - `color` string - `family` string - `size` string - `weight` integer - `sizeMobile` string - `weightMobile` integer - `payButton` ButtonStateConfig - `enabled` ButtonAppearanceConfig - `font` FontConfig - `color` string - `family` string - `size` string - `weight` integer - `sizeMobile` string - `weightMobile` integer - `backgroundColor` string - `disabled` ButtonAppearanceConfig - `font` FontConfig - `color` string - `family` string - `size` string - `weight` integer - `sizeMobile` string - `weightMobile` integer - `backgroundColor` string - `continueButton` ButtonStateConfig - `enabled` ButtonAppearanceConfig - `font` FontConfig - `color` string - `family` string - `size` string - `weight` integer - `sizeMobile` string - `weightMobile` integer - `backgroundColor` string - `disabled` ButtonAppearanceConfig - `font` FontConfig - `color` string - `family` string - `size` string - `weight` integer - `sizeMobile` string - `weightMobile` integer - `backgroundColor` string - `orderLineName` FontConfig - `color` string - `family` string - `size` string - `weight` integer - `sizeMobile` string - `weightMobile` integer - `orderLineQuantity` FontConfig - `color` string - `family` string - `size` string - `weight` integer - `sizeMobile` string - `weightMobile` integer - `orderLineAmount` FontConfig - `color` string - `family` string - `size` string - `weight` integer - `sizeMobile` string - `weightMobile` integer - `inputs` InputConfig - `border` BorderTypeConfig - `standard` BorderConfig - `width` string - `color` string - `radius` string - `focused` BorderConfig - `width` string - `color` string - `radius` string - `valid` BorderConfig - `width` string - `color` string - `radius` string - `invalid` BorderConfig - `width` string - `color` string - `radius` string - `standardText` FontConfig - `color` string - `family` string - `size` string - `weight` integer - `sizeMobile` string - `weightMobile` integer - `placeholderText` FontConfig - `color` string - `family` string - `size` string - `weight` integer - `sizeMobile` string - `weightMobile` integer - `spacing` SpacingConfig - `padding` PaddingConfig - `top` string - `bottom` string - `right` string - `left` string - `margin` MarginConfig - `top` string - `bottom` string - `right` string - `left` string - `boxShadowColor` string - `companyName` FontConfig - `color` string - `family` string - `size` string - `weight` integer - `sizeMobile` string - `weightMobile` integer - `companyAddress` FontConfig - `color` string - `family` string - `size` string - `weight` integer - `sizeMobile` string - `weightMobile` integer - `title` FontConfig - `color` string - `family` string - `size` string - `weight` integer - `sizeMobile` string - `weightMobile` integer - `subTitle` FontConfig - `color` string - `family` string - `size` string - `weight` integer - `sizeMobile` string - `weightMobile` integer - `termsLine` FontConfig - `color` string - `family` string - `size` string - `weight` integer - `sizeMobile` string - `weightMobile` integer - `pricingItemTitle` FontConfig - `color` string - `family` string - `size` string - `weight` integer - `sizeMobile` string - `weightMobile` integer - `pricingItemRow` FontConfig - `color` string - `family` string - `size` string - `weight` integer - `sizeMobile` string - `weightMobile` integer - `coBrandedCardSelection` boolean - `coBrandedVisaDankortPreference` string - `styleOptions` object - `locale` string, required: Session locale - `cancelUrl` string - `acceptUrl` string - `cancelUrlScheme` string - `acceptUrlScheme` string - `paymentMethods` SessionPaymentMethods - `cardTypes` SessionPaymentMethod[] - `type` 'CARD' | 'ANYDAY' | 'APPLEPAY' | 'GOOGLEPAY' | 'PAYPAL' | 'SWISH' | 'VIABILL' | 'VIPPS' | 'VIPPS_RECURRING' | 'VIPPS_EPAYMENT' | 'MOBILEPAY' | 'MOBILEPAY_SUBSCRIPTIONS' | 'KLARNA' | 'KLARNA_PAY_NOW' | 'KLARNA_PAY_LATER' | 'KLARNA_SLICE_IT' | 'KLARNA_DIRECT_BANK_TRANSFER' | 'KLARNA_DIRECT_DEBIT' | 'RESURS' | 'EMV_TOKEN' | 'PP_BANCOMATPAY' | 'PP_BANCONTACT' | 'PP_BLIK' | 'PP_BLIK_OC' | 'PP_EPS' | 'PP_ESTONIA_BANKS' | 'PP_GIROPAY' | 'PP_IDEAL' | 'PP_LATVIA_BANKS' | 'PP_LITHUANIA_BANKS' | 'PP_MB_WAY' | 'PP_MULTIBANCO' | 'PP_MYBANK' | 'PP_P24' | 'PP_PAYCONIQ' | 'PP_PAYSAFECARD' | 'PP_PAYSERA' | 'PP_POSTFINANCE' | 'PP_SATISPAY' | 'PP_SEPA' | 'PP_TRUSTLY' | 'PP_TWINT' | 'PP_VERKKOPANKKI' | 'PP_WECHATPAY' | 'PP_WERO' | 'PE_SANTANDER' | 'MANUAL' | 'OFFLINE_BANK_TRANSFER' | 'OFFLINE_CASH' | 'OFFLINE_OTHER' | 'SEPA_EBICS' | 'STRIPE_SEPA' | 'CLICK_TO_PAY' | 'AGENTIC' - `currencies` string[] - `secureVerification` boolean - `tinkMerchantId` string - `offlinePaymentTypeName` string - `offlinePaymentTypeHandle` string - `offlinePaymentTypeDescription` string - `offlinePaymentTypeInstructions` string - `offlinePaymentTypeLogo` string - `offlinePaymentTermsInDays` integer - `clickToPayDpaId` string - `card_type` 'UNKNOWN' | 'VISA' | 'MC' | 'DANKORT' | 'VISA_DK' | 'FFK' | 'VISA_ELEC' | 'MAESTRO' | 'LASER' | 'AMEX' | 'DINERS' | 'DISCOVER' | 'JCB' | 'CHINA_UNION_PAY' - `sca_rule` 'USE_SCA_IF_AVAILABLE_PREAUTH' | 'USE_SCA_IF_AVAILABLE_AUTH' | 'MUST_USE_SCA_PREAUTH' | 'MUST_USE_SCA_AUTH' | 'DO_NOT_USE_SCA' - `paymentTypes` SessionPaymentMethod[] - `type` 'CARD' | 'ANYDAY' | 'APPLEPAY' | 'GOOGLEPAY' | 'PAYPAL' | 'SWISH' | 'VIABILL' | 'VIPPS' | 'VIPPS_RECURRING' | 'VIPPS_EPAYMENT' | 'MOBILEPAY' | 'MOBILEPAY_SUBSCRIPTIONS' | 'KLARNA' | 'KLARNA_PAY_NOW' | 'KLARNA_PAY_LATER' | 'KLARNA_SLICE_IT' | 'KLARNA_DIRECT_BANK_TRANSFER' | 'KLARNA_DIRECT_DEBIT' | 'RESURS' | 'EMV_TOKEN' | 'PP_BANCOMATPAY' | 'PP_BANCONTACT' | 'PP_BLIK' | 'PP_BLIK_OC' | 'PP_EPS' | 'PP_ESTONIA_BANKS' | 'PP_GIROPAY' | 'PP_IDEAL' | 'PP_LATVIA_BANKS' | 'PP_LITHUANIA_BANKS' | 'PP_MB_WAY' | 'PP_MULTIBANCO' | 'PP_MYBANK' | 'PP_P24' | 'PP_PAYCONIQ' | 'PP_PAYSAFECARD' | 'PP_PAYSERA' | 'PP_POSTFINANCE' | 'PP_SATISPAY' | 'PP_SEPA' | 'PP_TRUSTLY' | 'PP_TWINT' | 'PP_VERKKOPANKKI' | 'PP_WECHATPAY' | 'PP_WERO' | 'PE_SANTANDER' | 'MANUAL' | 'OFFLINE_BANK_TRANSFER' | 'OFFLINE_CASH' | 'OFFLINE_OTHER' | 'SEPA_EBICS' | 'STRIPE_SEPA' | 'CLICK_TO_PAY' | 'AGENTIC' - `currencies` string[] - `secureVerification` boolean - `tinkMerchantId` string - `offlinePaymentTypeName` string - `offlinePaymentTypeHandle` string - `offlinePaymentTypeDescription` string - `offlinePaymentTypeInstructions` string - `offlinePaymentTypeLogo` string - `offlinePaymentTermsInDays` integer - `clickToPayDpaId` string - `card_type` 'UNKNOWN' | 'VISA' | 'MC' | 'DANKORT' | 'VISA_DK' | 'FFK' | 'VISA_ELEC' | 'MAESTRO' | 'LASER' | 'AMEX' | 'DINERS' | 'DISCOVER' | 'JCB' | 'CHINA_UNION_PAY' - `sca_rule` 'USE_SCA_IF_AVAILABLE_PREAUTH' | 'USE_SCA_IF_AVAILABLE_AUTH' | 'MUST_USE_SCA_PREAUTH' | 'MUST_USE_SCA_AUTH' | 'DO_NOT_USE_SCA' - `paymentTypePriority` string[] - `subscriptionInvoice` Invoice: Next invoice preview - `id` string, required: Invoice id assigned by Frisbii - `handle` string, required: Per account unique handle. Provided at on-demand invoice/charge creation or set to `inv-` for automatically created subscription invoices - `customer` string, required: Customer handle - `subscription` string: Subscription handle, will be null for a one-time customer invoice - `plan` 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 - `state` 'created' | 'pending' | 'dunning' | 'settled' | 'authorized' | 'cancelled' | 'failed' | 'unfinalized', required: The invoice state one of the following: `created`, `pending`, `dunning`, `settled`, `cancelled`, `authorized`, `failed`, `unfinalized` - `processing` boolean: For asynchronous payment methods, e.g. MobilePay subscriptions, this flag indicates that an invoice transaction is in state processing and is awaiting result. - `type` 's' | 'so' | 'soi' | 'co' | 'ch', required: The type of invoice: `s` - subscription recurring, `so` - subscription one-time, `soi` - subscription one-time instant, `co` - customer one-time, `ch` - charge - `amount` integer, required: The invoice amount including VAT - `number` integer: Sequential invoice number. Only present for subscription and customer invoices. - `currency` string, required: Invoice currency in [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) three letter alpha code - `due` string, date-time, required: When is the invoice due, simply the date from which the invoice is eligible to be paid, not to be confused with due date from payment terms as result of an offline transaction, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `failed` string, date-time: When the invoice failed, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `settled` string, date-time: When the invoice settled, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `cancelled` string, date-time: When the invoice was cancelled, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `authorized` string, date-time: When the invoice was authorized, if the invoice went through an authorize and settle flow, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `credits` CreditInvoice[], required: Credits applied to invoice - `credit` string, required: Credit handle - `amount` integer, required: The credit amount transferred to invoice - `created` string, date-time, required: Date when credit was transferred to invoice. In [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `text` string, required: Text describing the credit. - `created` string, date-time, required: When the invoice was created, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `plan_version` integer: Subscription plan version - `dunning_plan` string: Dunning plan handle - `discount_amount` integer, required: The potential discount amount deducted from the invoice amount including VAT - `org_amount` integer, required: The invoice original amount including VAT, may differ from amount if adjustments have been applied for the invoice - `amount_vat` integer, required: The invoice vat amount calculated as rounded summed fractional vats for each orderline - `amount_ex_vat` integer, required: The invoice amount without vat - `settled_amount` integer, required: Settled amount - `refunded_amount` integer, required: Refunded amount - `authorized_amount` integer: Authorized amount - `credited_amount` integer: Credited amount - `period_number` integer: The subscription period this invoice is for - `recurring_payment_method` string: Optional reference to recurring payment method created in conjunction with charging - `order_lines` OrderLine[], required: Order lines for invoice sorted by descending timestamp - `id` string, required: Per account unique order line id - `ordertext` string, required: Order line text - `amount` integer, required: Order line total amount including vat - `vat` number, float, required: Order line vat percent - `quantity` integer, required: Order line quantity - `origin` 'plan' | 'add_on' | 'ondemand' | 'additional_cost' | 'credit' | 'discount' | 'setup_fee' | 'surcharge_fee' | 'metered_billing_product', required: Order line origin, one of the following: `plan`, `add_on`, `ondemand`, `additional_cost`, `credit`, `discount`, `setup_fee`, `surcharge_fee`, `metered_billing_product` - `timestamp` string, date-time, required: Timestamp from order line origin, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `amount_vat` integer, required: Order line total vat amount - `amount_ex_vat` integer, required: Order line total amount without vat - `discounted_amount` integer: Order line amount after potential discount has been deducted, including vat - `discounted_amount_ex_vat` integer: Order line amount after potential discount has been deducted, excluding vat - `unit_amount` integer, required: Order line unit amount including vat - `unit_amount_vat` integer, required: Order line unit vat amount - `unit_amount_ex_vat` integer, required: Order line unit amount without vat - `amount_defined_incl_vat` boolean, required: Whether the amount was defined including VAT. E.g. plan amount defined including VAT. - `applied_tax_rule` 'reverse_charge' | 'intra_community_digital_service' | 'third_country' | 'fiscal_unity': Tax rule applied for order line indicates who is liable to account for the VAT. - `origin_handle` string: Handle for additional cost, credit, plan or subscription discount in the case one of those are the origin - `period_from` string, date-time: The start of billing period if the order line is a plan order line for a specific billing period, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `period_to` string, date-time: The end of billing period if the order line is a plan order line for a specific billing period, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `discount_percentage` integer: The discount percentage for discount order lines that has a percentage discount - `discounted_order_line` string: For discount order lines a reference to the order line for which the order line is a discount - `cost_object` string: Cost object number (Kostenträger-Nr.) this line is booked to - `additional_costs` string[], required: Additional cost handles for any additional costs added to this invoice - `transactions` Transaction[], required: Invoice transactions, ascending order and limited to 100 transactions - `id` string, required: Transaction id assigned by Frisbii - `state` 'pending' | 'processing' | 'authorized' | 'settled' | 'refunded' | 'failed' | 'cancelled', required: State of the transaction, one of the following: `pending`, `processing`, `authorized`, `settled`, `refunded`, `failed`, `cancelled` - `invoice` string, required: Invoice handle - `type` 'settle' | 'refund' | 'authorization', required: Transaction type, one of the following: `settle`, `refund`, `authorization` - `amount` integer, required: The transaction amount - `currency` string: Currency in [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) three letter alpha code - `settled` string, date-time: When the transaction was settled, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `authorized` string, date-time: When the transaction was authorized, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `failed` string, date-time: When the transaction failed, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `refunded` string, date-time: When the transaction was refunded, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `created` string, date-time, required: Date when the transaction was created. In [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `payment_type` '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' | 'sepa_ebics' | 'click_to_pay' | 'stripe_sepa', 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`, `offline_other`, `sepa_ebics`, `click_to_pay`, `stripe_sepa` - `payment_method` string: Reference to payment method in case of a MIT transaction - `card_transaction` CardTransaction: Specifics in case of GooglePay transaction - `card` Card: Saved card used for transaction. Only present if a saved card was used. - `id` string, required: Unique id for payment method - `state` 'active' | 'inactivated' | 'failed' | 'pending' | 'deleted', required: State of the payment method: `active`, `inactivated`, `failed`, `pending` or `deleted` - `customer` string, required: Customer by handle - `reference` string: Optional reference provided when creating the payment method. For payment methods created with Frisbii Checkout the reference will correspond to the session id for the Checkout session that created the payment method. - `failed` string, date-time: Date when the payment method failed. In ISO-8601 extended offset date-time format. - `created` string, date-time, required: Date when the payment method was created. In ISO-8601 extended offset date-time format. - `fingerprint` string: Uniquely identifies this particular card number - `reactivated` string, date-time: Date and time of reactivation if the card has been reactivated from failed state. In ISO-8601 extended offset date-time format. - `gw_ref` string, required: Card gateway reference id - `card_type` 'unknown' | 'visa' | 'mc' | 'dankort' | 'visa_dk' | 'ffk' | 'visa_elec' | 'maestro' | 'laser' | 'amex' | 'diners' | 'discover' | 'jcb' | 'china_union_pay', required: Card type: `unknown`, `visa`, `mc`, `dankort`, `visa_dk`, `ffk`, `visa_elec`, `maestro`, `laser`, `amex`, `diners`, `discover`, `jcb` or `china_union_pay` - `transaction_card_type` 'unknown' | 'visa' | 'mc' | 'dankort' | 'visa_dk' | 'ffk' | 'visa_elec' | 'maestro' | 'laser' | 'amex' | 'diners' | 'discover' | 'jcb' | 'china_union_pay': Card type used in authentication and the card type used for subsequent MIT transactions. Will differ from `card_type` if co-branded card. `unknown`, `visa`, `mc`, `dankort`, `visa_dk`, `ffk`, `visa_elec`, `maestro`, `laser`, `amex`, `diners`, `discover`, `jcb` or `china_union_pay` - `exp_date` string: Card expire date on form MM-YY - `masked_card` string: Masked card number - `last_success` string, date-time: Date and time of last successful use of the card. In ISO-8601 extended offset date-time format. - `last_failed` string, date-time: Date and time of last failed use of the card. In ISO-8601 extended offset date-time format. - `first_fail` string, date-time: Date and time of first successful use of the card. In ISO-8601 extended offset date-time format. - `error_code` string: An error code from the last failed use of the card. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state from last failed use of the card: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `strong_authentication_status` 'threed_secure' | 'threed_secure_not_enrolled' | 'secured_by_nets': Status for strong customer authentication: `threed_secure` - 3D Secure authenticated, `threed_secure_not_enrolled` - 3D Secure authentication not performed as card not enrolled, `secured_by_nets` - Secure by Nets authenticated - `three_d_secure_status` string: If 3D Secure authenticated the 3D status will either be `Y` (fully authenticated) or `A` (attempted authenticated). An attempted authentication means that card issuer (e.g. bank) does not support 3D Secure so no full authentication has been performed. Attempted authentication normally means liability shift, but this can differ between acquirers. - `risk_rule` string: If this parameter is set the card has been flagged by Frisbii Risk Filter with a flag rule. Special attention may be required before using the card for recurring payments or subscription sign-up. - `card_country` string: Card issuing country in [ISO 3166-1 alpha-2](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `fingerprint` string: Uniquely identifies this particular card number - `provider` 'reepay' | 'aibms' | 'bambora' | 'barclays' | 'clearhaus' | 'cmcic' | 'credibanco' | 'cs' | 'elavon' | 'evry' | 'first_data' | 'handelsbanken' | 'hsbc' | 'nets' | 'shift4' | 'spreedly' | 'swedbank' | 'thailand_kbank' | 'valitor' | 'worldline' | 'worldpay' | 'test': Card acquirer or card payment gateway used if card source: `reepay`, `aibms`, `bambora`, `barclays`, `clearhaus`, `cmcic`, `credibanco`, `cs`, `elavon`, `evry`, `first_data`, `handelsbanken`, `hsbc`, `nets`, `shift4`, `spreedly`, `swedbank`, `thailand_kbank`, `valitor`, `worldline`, `worldpay`, `test` - `frictionless` boolean: If the transaction was exempted from a 3DS challenge - `ref_transaction` string: Id of a possible referenced transaction - `gw_id` string: Gateway id for card - `last_failed` string, date-time: When the card transaction last failed, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `first_failed` string, date-time: When the card transaction first failed, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `card_type` 'unknown' | 'visa' | 'mc' | 'dankort' | 'visa_dk' | 'ffk' | 'visa_elec' | 'maestro' | 'laser' | 'amex' | 'diners' | 'discover' | 'jcb' | 'china_union_pay', required: Card type: `unknown`, `visa`, `mc`, `dankort`, `visa_dk`, `ffk`, `visa_elec`, `maestro`, `laser`, `amex`, `diners`, `discover`, `jcb` or `china_union_pay` - `transaction_card_type` 'unknown' | 'visa' | 'mc' | 'dankort' | 'visa_dk' | 'ffk' | 'visa_elec' | 'maestro' | 'laser' | 'amex' | 'diners' | 'discover' | 'jcb' | 'china_union_pay': Transaction card type. Will differ from `card_type` if co-branded card. Transaction card type is the card type used for the transaction. `unknown`, `visa`, `mc`, `dankort`, `visa_dk`, `ffk`, `visa_elec`, `maestro`, `laser`, `amex`, `diners`, `discover`, `jcb` or `china_union_pay` - `exp_date` string: Card expire date on form MM-YY - `masked_card` string: Masked card number - `card_country` string: Card issuing country in [ISO 3166-1 alpha-2](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - `strong_authentication_status` 'threed_secure' | 'threed_secure_not_enrolled' | 'secured_by_nets': Status for strong customer authentication: `threed_secure` - 3D Secure authenticated, `threed_secure_not_enrolled` - 3D Secure authentication not performed as card not enrolled, `secured_by_nets` - Secure by Nets authenticated - `three_d_secure_status` string: If 3D Secure authenticated the 3D status will either be `Y` (fully authenticated) or `A` (attempted authenticated). An attempted authentication means that card issuer (e.g. bank) does not support 3D Secure so no full authentication has been performed. Attempted authentication normally means liability shift, but this can differ between acquirers. - `risk_rule` string: If this parameter is set the transaction has either been flagged or declined by a Frisbii Risk Filter rule. For flag action rules the transaction can be successful, but may require special attention. For block action rules the decline error will be `risk_filter_block`. - `acquirer_code` string: Acquirer error code in case of error - `acquirer_message` string: Acquirer message in case of error - `acquirer_reference` string: Acquirer reference to transaction. E.g. Nets order id or Clearhaus reference. - `text_on_statement` string: Resulting text on bank statement if known - `surcharge_fee` integer: Potential card surcharge fee added to amount if surcharging enabled - `cardholder_name` string: Cardholder name if provided when entering credit card details - `ani_result` 'match' | 'partial_match' | 'no_match' | 'unverified' | 'not_supported': The result of the Account Name Inquiry (cardholder name verification) performed by the provider. Only relevant if cardholder name was provided and this transaction corresponds to a customer-initiated authorization or instant settle. - `mpo_transaction` CardTransaction: Specifics in case of GooglePay transaction - `card` Card: Saved card used for transaction. Only present if a saved card was used. - `id` string, required: Unique id for payment method - `state` 'active' | 'inactivated' | 'failed' | 'pending' | 'deleted', required: State of the payment method: `active`, `inactivated`, `failed`, `pending` or `deleted` - `customer` string, required: Customer by handle - `reference` string: Optional reference provided when creating the payment method. For payment methods created with Frisbii Checkout the reference will correspond to the session id for the Checkout session that created the payment method. - `failed` string, date-time: Date when the payment method failed. In ISO-8601 extended offset date-time format. - `created` string, date-time, required: Date when the payment method was created. In ISO-8601 extended offset date-time format. - `fingerprint` string: Uniquely identifies this particular card number - `reactivated` string, date-time: Date and time of reactivation if the card has been reactivated from failed state. In ISO-8601 extended offset date-time format. - `gw_ref` string, required: Card gateway reference id - `card_type` 'unknown' | 'visa' | 'mc' | 'dankort' | 'visa_dk' | 'ffk' | 'visa_elec' | 'maestro' | 'laser' | 'amex' | 'diners' | 'discover' | 'jcb' | 'china_union_pay', required: Card type: `unknown`, `visa`, `mc`, `dankort`, `visa_dk`, `ffk`, `visa_elec`, `maestro`, `laser`, `amex`, `diners`, `discover`, `jcb` or `china_union_pay` - `transaction_card_type` 'unknown' | 'visa' | 'mc' | 'dankort' | 'visa_dk' | 'ffk' | 'visa_elec' | 'maestro' | 'laser' | 'amex' | 'diners' | 'discover' | 'jcb' | 'china_union_pay': Card type used in authentication and the card type used for subsequent MIT transactions. Will differ from `card_type` if co-branded card. `unknown`, `visa`, `mc`, `dankort`, `visa_dk`, `ffk`, `visa_elec`, `maestro`, `laser`, `amex`, `diners`, `discover`, `jcb` or `china_union_pay` - `exp_date` string: Card expire date on form MM-YY - `masked_card` string: Masked card number - `last_success` string, date-time: Date and time of last successful use of the card. In ISO-8601 extended offset date-time format. - `last_failed` string, date-time: Date and time of last failed use of the card. In ISO-8601 extended offset date-time format. - `first_fail` string, date-time: Date and time of first successful use of the card. In ISO-8601 extended offset date-time format. - `error_code` string: An error code from the last failed use of the card. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state from last failed use of the card: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `strong_authentication_status` 'threed_secure' | 'threed_secure_not_enrolled' | 'secured_by_nets': Status for strong customer authentication: `threed_secure` - 3D Secure authenticated, `threed_secure_not_enrolled` - 3D Secure authentication not performed as card not enrolled, `secured_by_nets` - Secure by Nets authenticated - `three_d_secure_status` string: If 3D Secure authenticated the 3D status will either be `Y` (fully authenticated) or `A` (attempted authenticated). An attempted authentication means that card issuer (e.g. bank) does not support 3D Secure so no full authentication has been performed. Attempted authentication normally means liability shift, but this can differ between acquirers. - `risk_rule` string: If this parameter is set the card has been flagged by Frisbii Risk Filter with a flag rule. Special attention may be required before using the card for recurring payments or subscription sign-up. - `card_country` string: Card issuing country in [ISO 3166-1 alpha-2](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `fingerprint` string: Uniquely identifies this particular card number - `provider` 'reepay' | 'aibms' | 'bambora' | 'barclays' | 'clearhaus' | 'cmcic' | 'credibanco' | 'cs' | 'elavon' | 'evry' | 'first_data' | 'handelsbanken' | 'hsbc' | 'nets' | 'shift4' | 'spreedly' | 'swedbank' | 'thailand_kbank' | 'valitor' | 'worldline' | 'worldpay' | 'test': Card acquirer or card payment gateway used if card source: `reepay`, `aibms`, `bambora`, `barclays`, `clearhaus`, `cmcic`, `credibanco`, `cs`, `elavon`, `evry`, `first_data`, `handelsbanken`, `hsbc`, `nets`, `shift4`, `spreedly`, `swedbank`, `thailand_kbank`, `valitor`, `worldline`, `worldpay`, `test` - `frictionless` boolean: If the transaction was exempted from a 3DS challenge - `ref_transaction` string: Id of a possible referenced transaction - `gw_id` string: Gateway id for card - `last_failed` string, date-time: When the card transaction last failed, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `first_failed` string, date-time: When the card transaction first failed, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `card_type` 'unknown' | 'visa' | 'mc' | 'dankort' | 'visa_dk' | 'ffk' | 'visa_elec' | 'maestro' | 'laser' | 'amex' | 'diners' | 'discover' | 'jcb' | 'china_union_pay', required: Card type: `unknown`, `visa`, `mc`, `dankort`, `visa_dk`, `ffk`, `visa_elec`, `maestro`, `laser`, `amex`, `diners`, `discover`, `jcb` or `china_union_pay` - `transaction_card_type` 'unknown' | 'visa' | 'mc' | 'dankort' | 'visa_dk' | 'ffk' | 'visa_elec' | 'maestro' | 'laser' | 'amex' | 'diners' | 'discover' | 'jcb' | 'china_union_pay': Transaction card type. Will differ from `card_type` if co-branded card. Transaction card type is the card type used for the transaction. `unknown`, `visa`, `mc`, `dankort`, `visa_dk`, `ffk`, `visa_elec`, `maestro`, `laser`, `amex`, `diners`, `discover`, `jcb` or `china_union_pay` - `exp_date` string: Card expire date on form MM-YY - `masked_card` string: Masked card number - `card_country` string: Card issuing country in [ISO 3166-1 alpha-2](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - `strong_authentication_status` 'threed_secure' | 'threed_secure_not_enrolled' | 'secured_by_nets': Status for strong customer authentication: `threed_secure` - 3D Secure authenticated, `threed_secure_not_enrolled` - 3D Secure authentication not performed as card not enrolled, `secured_by_nets` - Secure by Nets authenticated - `three_d_secure_status` string: If 3D Secure authenticated the 3D status will either be `Y` (fully authenticated) or `A` (attempted authenticated). An attempted authentication means that card issuer (e.g. bank) does not support 3D Secure so no full authentication has been performed. Attempted authentication normally means liability shift, but this can differ between acquirers. - `risk_rule` string: If this parameter is set the transaction has either been flagged or declined by a Frisbii Risk Filter rule. For flag action rules the transaction can be successful, but may require special attention. For block action rules the decline error will be `risk_filter_block`. - `acquirer_code` string: Acquirer error code in case of error - `acquirer_message` string: Acquirer message in case of error - `acquirer_reference` string: Acquirer reference to transaction. E.g. Nets order id or Clearhaus reference. - `text_on_statement` string: Resulting text on bank statement if known - `surcharge_fee` integer: Potential card surcharge fee added to amount if surcharging enabled - `cardholder_name` string: Cardholder name if provided when entering credit card details - `ani_result` 'match' | 'partial_match' | 'no_match' | 'unverified' | 'not_supported': The result of the Account Name Inquiry (cardholder name verification) performed by the provider. Only relevant if cardholder name was provided and this transaction corresponds to a customer-initiated authorization or instant settle. - `vipps_transaction` CardTransaction: Specifics in case of GooglePay transaction - `card` Card: Saved card used for transaction. Only present if a saved card was used. - `id` string, required: Unique id for payment method - `state` 'active' | 'inactivated' | 'failed' | 'pending' | 'deleted', required: State of the payment method: `active`, `inactivated`, `failed`, `pending` or `deleted` - `customer` string, required: Customer by handle - `reference` string: Optional reference provided when creating the payment method. For payment methods created with Frisbii Checkout the reference will correspond to the session id for the Checkout session that created the payment method. - `failed` string, date-time: Date when the payment method failed. In ISO-8601 extended offset date-time format. - `created` string, date-time, required: Date when the payment method was created. In ISO-8601 extended offset date-time format. - `fingerprint` string: Uniquely identifies this particular card number - `reactivated` string, date-time: Date and time of reactivation if the card has been reactivated from failed state. In ISO-8601 extended offset date-time format. - `gw_ref` string, required: Card gateway reference id - `card_type` 'unknown' | 'visa' | 'mc' | 'dankort' | 'visa_dk' | 'ffk' | 'visa_elec' | 'maestro' | 'laser' | 'amex' | 'diners' | 'discover' | 'jcb' | 'china_union_pay', required: Card type: `unknown`, `visa`, `mc`, `dankort`, `visa_dk`, `ffk`, `visa_elec`, `maestro`, `laser`, `amex`, `diners`, `discover`, `jcb` or `china_union_pay` - `transaction_card_type` 'unknown' | 'visa' | 'mc' | 'dankort' | 'visa_dk' | 'ffk' | 'visa_elec' | 'maestro' | 'laser' | 'amex' | 'diners' | 'discover' | 'jcb' | 'china_union_pay': Card type used in authentication and the card type used for subsequent MIT transactions. Will differ from `card_type` if co-branded card. `unknown`, `visa`, `mc`, `dankort`, `visa_dk`, `ffk`, `visa_elec`, `maestro`, `laser`, `amex`, `diners`, `discover`, `jcb` or `china_union_pay` - `exp_date` string: Card expire date on form MM-YY - `masked_card` string: Masked card number - `last_success` string, date-time: Date and time of last successful use of the card. In ISO-8601 extended offset date-time format. - `last_failed` string, date-time: Date and time of last failed use of the card. In ISO-8601 extended offset date-time format. - `first_fail` string, date-time: Date and time of first successful use of the card. In ISO-8601 extended offset date-time format. - `error_code` string: An error code from the last failed use of the card. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state from last failed use of the card: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `strong_authentication_status` 'threed_secure' | 'threed_secure_not_enrolled' | 'secured_by_nets': Status for strong customer authentication: `threed_secure` - 3D Secure authenticated, `threed_secure_not_enrolled` - 3D Secure authentication not performed as card not enrolled, `secured_by_nets` - Secure by Nets authenticated - `three_d_secure_status` string: If 3D Secure authenticated the 3D status will either be `Y` (fully authenticated) or `A` (attempted authenticated). An attempted authentication means that card issuer (e.g. bank) does not support 3D Secure so no full authentication has been performed. Attempted authentication normally means liability shift, but this can differ between acquirers. - `risk_rule` string: If this parameter is set the card has been flagged by Frisbii Risk Filter with a flag rule. Special attention may be required before using the card for recurring payments or subscription sign-up. - `card_country` string: Card issuing country in [ISO 3166-1 alpha-2](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `fingerprint` string: Uniquely identifies this particular card number - `provider` 'reepay' | 'aibms' | 'bambora' | 'barclays' | 'clearhaus' | 'cmcic' | 'credibanco' | 'cs' | 'elavon' | 'evry' | 'first_data' | 'handelsbanken' | 'hsbc' | 'nets' | 'shift4' | 'spreedly' | 'swedbank' | 'thailand_kbank' | 'valitor' | 'worldline' | 'worldpay' | 'test': Card acquirer or card payment gateway used if card source: `reepay`, `aibms`, `bambora`, `barclays`, `clearhaus`, `cmcic`, `credibanco`, `cs`, `elavon`, `evry`, `first_data`, `handelsbanken`, `hsbc`, `nets`, `shift4`, `spreedly`, `swedbank`, `thailand_kbank`, `valitor`, `worldline`, `worldpay`, `test` - `frictionless` boolean: If the transaction was exempted from a 3DS challenge - `ref_transaction` string: Id of a possible referenced transaction - `gw_id` string: Gateway id for card - `last_failed` string, date-time: When the card transaction last failed, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `first_failed` string, date-time: When the card transaction first failed, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `card_type` 'unknown' | 'visa' | 'mc' | 'dankort' | 'visa_dk' | 'ffk' | 'visa_elec' | 'maestro' | 'laser' | 'amex' | 'diners' | 'discover' | 'jcb' | 'china_union_pay', required: Card type: `unknown`, `visa`, `mc`, `dankort`, `visa_dk`, `ffk`, `visa_elec`, `maestro`, `laser`, `amex`, `diners`, `discover`, `jcb` or `china_union_pay` - `transaction_card_type` 'unknown' | 'visa' | 'mc' | 'dankort' | 'visa_dk' | 'ffk' | 'visa_elec' | 'maestro' | 'laser' | 'amex' | 'diners' | 'discover' | 'jcb' | 'china_union_pay': Transaction card type. Will differ from `card_type` if co-branded card. Transaction card type is the card type used for the transaction. `unknown`, `visa`, `mc`, `dankort`, `visa_dk`, `ffk`, `visa_elec`, `maestro`, `laser`, `amex`, `diners`, `discover`, `jcb` or `china_union_pay` - `exp_date` string: Card expire date on form MM-YY - `masked_card` string: Masked card number - `card_country` string: Card issuing country in [ISO 3166-1 alpha-2](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - `strong_authentication_status` 'threed_secure' | 'threed_secure_not_enrolled' | 'secured_by_nets': Status for strong customer authentication: `threed_secure` - 3D Secure authenticated, `threed_secure_not_enrolled` - 3D Secure authentication not performed as card not enrolled, `secured_by_nets` - Secure by Nets authenticated - `three_d_secure_status` string: If 3D Secure authenticated the 3D status will either be `Y` (fully authenticated) or `A` (attempted authenticated). An attempted authentication means that card issuer (e.g. bank) does not support 3D Secure so no full authentication has been performed. Attempted authentication normally means liability shift, but this can differ between acquirers. - `risk_rule` string: If this parameter is set the transaction has either been flagged or declined by a Frisbii Risk Filter rule. For flag action rules the transaction can be successful, but may require special attention. For block action rules the decline error will be `risk_filter_block`. - `acquirer_code` string: Acquirer error code in case of error - `acquirer_message` string: Acquirer message in case of error - `acquirer_reference` string: Acquirer reference to transaction. E.g. Nets order id or Clearhaus reference. - `text_on_statement` string: Resulting text on bank statement if known - `surcharge_fee` integer: Potential card surcharge fee added to amount if surcharging enabled - `cardholder_name` string: Cardholder name if provided when entering credit card details - `ani_result` 'match' | 'partial_match' | 'no_match' | 'unverified' | 'not_supported': The result of the Account Name Inquiry (cardholder name verification) performed by the provider. Only relevant if cardholder name was provided and this transaction corresponds to a customer-initiated authorization or instant settle. - `applepay_transaction` CardTransaction: Specifics in case of GooglePay transaction - `card` Card: Saved card used for transaction. Only present if a saved card was used. - `id` string, required: Unique id for payment method - `state` 'active' | 'inactivated' | 'failed' | 'pending' | 'deleted', required: State of the payment method: `active`, `inactivated`, `failed`, `pending` or `deleted` - `customer` string, required: Customer by handle - `reference` string: Optional reference provided when creating the payment method. For payment methods created with Frisbii Checkout the reference will correspond to the session id for the Checkout session that created the payment method. - `failed` string, date-time: Date when the payment method failed. In ISO-8601 extended offset date-time format. - `created` string, date-time, required: Date when the payment method was created. In ISO-8601 extended offset date-time format. - `fingerprint` string: Uniquely identifies this particular card number - `reactivated` string, date-time: Date and time of reactivation if the card has been reactivated from failed state. In ISO-8601 extended offset date-time format. - `gw_ref` string, required: Card gateway reference id - `card_type` 'unknown' | 'visa' | 'mc' | 'dankort' | 'visa_dk' | 'ffk' | 'visa_elec' | 'maestro' | 'laser' | 'amex' | 'diners' | 'discover' | 'jcb' | 'china_union_pay', required: Card type: `unknown`, `visa`, `mc`, `dankort`, `visa_dk`, `ffk`, `visa_elec`, `maestro`, `laser`, `amex`, `diners`, `discover`, `jcb` or `china_union_pay` - `transaction_card_type` 'unknown' | 'visa' | 'mc' | 'dankort' | 'visa_dk' | 'ffk' | 'visa_elec' | 'maestro' | 'laser' | 'amex' | 'diners' | 'discover' | 'jcb' | 'china_union_pay': Card type used in authentication and the card type used for subsequent MIT transactions. Will differ from `card_type` if co-branded card. `unknown`, `visa`, `mc`, `dankort`, `visa_dk`, `ffk`, `visa_elec`, `maestro`, `laser`, `amex`, `diners`, `discover`, `jcb` or `china_union_pay` - `exp_date` string: Card expire date on form MM-YY - `masked_card` string: Masked card number - `last_success` string, date-time: Date and time of last successful use of the card. In ISO-8601 extended offset date-time format. - `last_failed` string, date-time: Date and time of last failed use of the card. In ISO-8601 extended offset date-time format. - `first_fail` string, date-time: Date and time of first successful use of the card. In ISO-8601 extended offset date-time format. - `error_code` string: An error code from the last failed use of the card. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state from last failed use of the card: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `strong_authentication_status` 'threed_secure' | 'threed_secure_not_enrolled' | 'secured_by_nets': Status for strong customer authentication: `threed_secure` - 3D Secure authenticated, `threed_secure_not_enrolled` - 3D Secure authentication not performed as card not enrolled, `secured_by_nets` - Secure by Nets authenticated - `three_d_secure_status` string: If 3D Secure authenticated the 3D status will either be `Y` (fully authenticated) or `A` (attempted authenticated). An attempted authentication means that card issuer (e.g. bank) does not support 3D Secure so no full authentication has been performed. Attempted authentication normally means liability shift, but this can differ between acquirers. - `risk_rule` string: If this parameter is set the card has been flagged by Frisbii Risk Filter with a flag rule. Special attention may be required before using the card for recurring payments or subscription sign-up. - `card_country` string: Card issuing country in [ISO 3166-1 alpha-2](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `fingerprint` string: Uniquely identifies this particular card number - `provider` 'reepay' | 'aibms' | 'bambora' | 'barclays' | 'clearhaus' | 'cmcic' | 'credibanco' | 'cs' | 'elavon' | 'evry' | 'first_data' | 'handelsbanken' | 'hsbc' | 'nets' | 'shift4' | 'spreedly' | 'swedbank' | 'thailand_kbank' | 'valitor' | 'worldline' | 'worldpay' | 'test': Card acquirer or card payment gateway used if card source: `reepay`, `aibms`, `bambora`, `barclays`, `clearhaus`, `cmcic`, `credibanco`, `cs`, `elavon`, `evry`, `first_data`, `handelsbanken`, `hsbc`, `nets`, `shift4`, `spreedly`, `swedbank`, `thailand_kbank`, `valitor`, `worldline`, `worldpay`, `test` - `frictionless` boolean: If the transaction was exempted from a 3DS challenge - `ref_transaction` string: Id of a possible referenced transaction - `gw_id` string: Gateway id for card - `last_failed` string, date-time: When the card transaction last failed, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `first_failed` string, date-time: When the card transaction first failed, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `card_type` 'unknown' | 'visa' | 'mc' | 'dankort' | 'visa_dk' | 'ffk' | 'visa_elec' | 'maestro' | 'laser' | 'amex' | 'diners' | 'discover' | 'jcb' | 'china_union_pay', required: Card type: `unknown`, `visa`, `mc`, `dankort`, `visa_dk`, `ffk`, `visa_elec`, `maestro`, `laser`, `amex`, `diners`, `discover`, `jcb` or `china_union_pay` - `transaction_card_type` 'unknown' | 'visa' | 'mc' | 'dankort' | 'visa_dk' | 'ffk' | 'visa_elec' | 'maestro' | 'laser' | 'amex' | 'diners' | 'discover' | 'jcb' | 'china_union_pay': Transaction card type. Will differ from `card_type` if co-branded card. Transaction card type is the card type used for the transaction. `unknown`, `visa`, `mc`, `dankort`, `visa_dk`, `ffk`, `visa_elec`, `maestro`, `laser`, `amex`, `diners`, `discover`, `jcb` or `china_union_pay` - `exp_date` string: Card expire date on form MM-YY - `masked_card` string: Masked card number - `card_country` string: Card issuing country in [ISO 3166-1 alpha-2](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - `strong_authentication_status` 'threed_secure' | 'threed_secure_not_enrolled' | 'secured_by_nets': Status for strong customer authentication: `threed_secure` - 3D Secure authenticated, `threed_secure_not_enrolled` - 3D Secure authentication not performed as card not enrolled, `secured_by_nets` - Secure by Nets authenticated - `three_d_secure_status` string: If 3D Secure authenticated the 3D status will either be `Y` (fully authenticated) or `A` (attempted authenticated). An attempted authentication means that card issuer (e.g. bank) does not support 3D Secure so no full authentication has been performed. Attempted authentication normally means liability shift, but this can differ between acquirers. - `risk_rule` string: If this parameter is set the transaction has either been flagged or declined by a Frisbii Risk Filter rule. For flag action rules the transaction can be successful, but may require special attention. For block action rules the decline error will be `risk_filter_block`. - `acquirer_code` string: Acquirer error code in case of error - `acquirer_message` string: Acquirer message in case of error - `acquirer_reference` string: Acquirer reference to transaction. E.g. Nets order id or Clearhaus reference. - `text_on_statement` string: Resulting text on bank statement if known - `surcharge_fee` integer: Potential card surcharge fee added to amount if surcharging enabled - `cardholder_name` string: Cardholder name if provided when entering credit card details - `ani_result` 'match' | 'partial_match' | 'no_match' | 'unverified' | 'not_supported': The result of the Account Name Inquiry (cardholder name verification) performed by the provider. Only relevant if cardholder name was provided and this transaction corresponds to a customer-initiated authorization or instant settle. - `googlepay_transaction` CardTransaction: Specifics in case of GooglePay transaction - `card` Card: Saved card used for transaction. Only present if a saved card was used. - `id` string, required: Unique id for payment method - `state` 'active' | 'inactivated' | 'failed' | 'pending' | 'deleted', required: State of the payment method: `active`, `inactivated`, `failed`, `pending` or `deleted` - `customer` string, required: Customer by handle - `reference` string: Optional reference provided when creating the payment method. For payment methods created with Frisbii Checkout the reference will correspond to the session id for the Checkout session that created the payment method. - `failed` string, date-time: Date when the payment method failed. In ISO-8601 extended offset date-time format. - `created` string, date-time, required: Date when the payment method was created. In ISO-8601 extended offset date-time format. - `fingerprint` string: Uniquely identifies this particular card number - `reactivated` string, date-time: Date and time of reactivation if the card has been reactivated from failed state. In ISO-8601 extended offset date-time format. - `gw_ref` string, required: Card gateway reference id - `card_type` 'unknown' | 'visa' | 'mc' | 'dankort' | 'visa_dk' | 'ffk' | 'visa_elec' | 'maestro' | 'laser' | 'amex' | 'diners' | 'discover' | 'jcb' | 'china_union_pay', required: Card type: `unknown`, `visa`, `mc`, `dankort`, `visa_dk`, `ffk`, `visa_elec`, `maestro`, `laser`, `amex`, `diners`, `discover`, `jcb` or `china_union_pay` - `transaction_card_type` 'unknown' | 'visa' | 'mc' | 'dankort' | 'visa_dk' | 'ffk' | 'visa_elec' | 'maestro' | 'laser' | 'amex' | 'diners' | 'discover' | 'jcb' | 'china_union_pay': Card type used in authentication and the card type used for subsequent MIT transactions. Will differ from `card_type` if co-branded card. `unknown`, `visa`, `mc`, `dankort`, `visa_dk`, `ffk`, `visa_elec`, `maestro`, `laser`, `amex`, `diners`, `discover`, `jcb` or `china_union_pay` - `exp_date` string: Card expire date on form MM-YY - `masked_card` string: Masked card number - `last_success` string, date-time: Date and time of last successful use of the card. In ISO-8601 extended offset date-time format. - `last_failed` string, date-time: Date and time of last failed use of the card. In ISO-8601 extended offset date-time format. - `first_fail` string, date-time: Date and time of first successful use of the card. In ISO-8601 extended offset date-time format. - `error_code` string: An error code from the last failed use of the card. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state from last failed use of the card: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `strong_authentication_status` 'threed_secure' | 'threed_secure_not_enrolled' | 'secured_by_nets': Status for strong customer authentication: `threed_secure` - 3D Secure authenticated, `threed_secure_not_enrolled` - 3D Secure authentication not performed as card not enrolled, `secured_by_nets` - Secure by Nets authenticated - `three_d_secure_status` string: If 3D Secure authenticated the 3D status will either be `Y` (fully authenticated) or `A` (attempted authenticated). An attempted authentication means that card issuer (e.g. bank) does not support 3D Secure so no full authentication has been performed. Attempted authentication normally means liability shift, but this can differ between acquirers. - `risk_rule` string: If this parameter is set the card has been flagged by Frisbii Risk Filter with a flag rule. Special attention may be required before using the card for recurring payments or subscription sign-up. - `card_country` string: Card issuing country in [ISO 3166-1 alpha-2](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `fingerprint` string: Uniquely identifies this particular card number - `provider` 'reepay' | 'aibms' | 'bambora' | 'barclays' | 'clearhaus' | 'cmcic' | 'credibanco' | 'cs' | 'elavon' | 'evry' | 'first_data' | 'handelsbanken' | 'hsbc' | 'nets' | 'shift4' | 'spreedly' | 'swedbank' | 'thailand_kbank' | 'valitor' | 'worldline' | 'worldpay' | 'test': Card acquirer or card payment gateway used if card source: `reepay`, `aibms`, `bambora`, `barclays`, `clearhaus`, `cmcic`, `credibanco`, `cs`, `elavon`, `evry`, `first_data`, `handelsbanken`, `hsbc`, `nets`, `shift4`, `spreedly`, `swedbank`, `thailand_kbank`, `valitor`, `worldline`, `worldpay`, `test` - `frictionless` boolean: If the transaction was exempted from a 3DS challenge - `ref_transaction` string: Id of a possible referenced transaction - `gw_id` string: Gateway id for card - `last_failed` string, date-time: When the card transaction last failed, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `first_failed` string, date-time: When the card transaction first failed, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `card_type` 'unknown' | 'visa' | 'mc' | 'dankort' | 'visa_dk' | 'ffk' | 'visa_elec' | 'maestro' | 'laser' | 'amex' | 'diners' | 'discover' | 'jcb' | 'china_union_pay', required: Card type: `unknown`, `visa`, `mc`, `dankort`, `visa_dk`, `ffk`, `visa_elec`, `maestro`, `laser`, `amex`, `diners`, `discover`, `jcb` or `china_union_pay` - `transaction_card_type` 'unknown' | 'visa' | 'mc' | 'dankort' | 'visa_dk' | 'ffk' | 'visa_elec' | 'maestro' | 'laser' | 'amex' | 'diners' | 'discover' | 'jcb' | 'china_union_pay': Transaction card type. Will differ from `card_type` if co-branded card. Transaction card type is the card type used for the transaction. `unknown`, `visa`, `mc`, `dankort`, `visa_dk`, `ffk`, `visa_elec`, `maestro`, `laser`, `amex`, `diners`, `discover`, `jcb` or `china_union_pay` - `exp_date` string: Card expire date on form MM-YY - `masked_card` string: Masked card number - `card_country` string: Card issuing country in [ISO 3166-1 alpha-2](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - `strong_authentication_status` 'threed_secure' | 'threed_secure_not_enrolled' | 'secured_by_nets': Status for strong customer authentication: `threed_secure` - 3D Secure authenticated, `threed_secure_not_enrolled` - 3D Secure authentication not performed as card not enrolled, `secured_by_nets` - Secure by Nets authenticated - `three_d_secure_status` string: If 3D Secure authenticated the 3D status will either be `Y` (fully authenticated) or `A` (attempted authenticated). An attempted authentication means that card issuer (e.g. bank) does not support 3D Secure so no full authentication has been performed. Attempted authentication normally means liability shift, but this can differ between acquirers. - `risk_rule` string: If this parameter is set the transaction has either been flagged or declined by a Frisbii Risk Filter rule. For flag action rules the transaction can be successful, but may require special attention. For block action rules the decline error will be `risk_filter_block`. - `acquirer_code` string: Acquirer error code in case of error - `acquirer_message` string: Acquirer message in case of error - `acquirer_reference` string: Acquirer reference to transaction. E.g. Nets order id or Clearhaus reference. - `text_on_statement` string: Resulting text on bank statement if known - `surcharge_fee` integer: Potential card surcharge fee added to amount if surcharging enabled - `cardholder_name` string: Cardholder name if provided when entering credit card details - `ani_result` 'match' | 'partial_match' | 'no_match' | 'unverified' | 'not_supported': The result of the Account Name Inquiry (cardholder name verification) performed by the provider. Only relevant if cardholder name was provided and this transaction corresponds to a customer-initiated authorization or instant settle. - `manual_transaction` ManualTransaction: Specifics in case of manual transaction - `method` 'cash' | 'bank_transfer' | 'check' | 'chargeback' | 'other', required: The method used for the offline manual transaction, allowable values: `cash`, `bank_transfer`, `check`, `chargeback`, `other` - `comment` string: Optional comment for manual transaction - `reference` string: Optional reference for the manual transaction - `payment_date` string, date-time, required: When the manual transaction was performed on the form `yyyy-MM-dd`, `yyyyMMdd`, `yyyy-MM-ddTHH:mm` and `yyyy-MM-ddTHH:mm:ss` - `viabill_transaction` ViabillTransaction: Specifics in case of ViaBill transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `viabill_id` string: ViaBill id - `anyday_transaction` AnydayTransaction: Specifics in case of Anyday transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `anyday_id` string: Anyday id - `santander_transaction` SantanderTransaction: Specifics in case of Santander transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `santander_id` string: Santander id - `resurs_transaction` ResursTransaction: Specifics in case of Resurs Bank transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `resurs_id` string: Resurs id - `klarna_transaction` KlarnaTransaction: Specifics in case of Klarna transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `type` 'klarna' | 'klarna_pay_now' | 'klarna_pay_later' | 'klarna_slice_it' | 'klarna_direct_bank_transfer' | 'klarna_direct_debit', required: Transaction type: `klarna` - recurring Klarna mandate payment, `klarna_pay_now`, `klarna_pay_later`, `klarna_slice_it`, `klarna_direct_bank_transfer`, `klarna_direct_debit` - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `klarna_id` string: Klarna id - `klarna_mandate` KlarnaMandate: Klarna mandate used to initiate transaction when transaction is recurring - `swish_transaction` SwishTransaction: Specifics in case of Swish transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `swish_id` string: Swish id - `paypal_transaction` PaypalTransaction: Specifics in case of PayPal transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `email` string: Payer email - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `paypal_id` string: PayPal id - `paypal_mandate` PaypalMandate: PayPal mandate used to initiate transaction when transaction is recurring - `email` string: Payer email - `first_name` string: Payer first name - `last_name` string: Payer last name - `payer_id` string: PayPal payer id - `phone_number` string: Payer phone number - `first_name` string: Payer first name - `last_name` string: Payer last name - `payer_id` string: PayPal payer id - `phone_number` string: Payer phone number - `bancomatpay_transaction` BancomatPayTransaction: Specifics in case of Bancomat Pay transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `bancomatpay_id` string: Bancomat Pay id - `bancontact_transaction` BancontactTransaction: Specifics in case of Bancontact transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `bancontact_id` string: Bancontact id - `blik_transaction` BlikTransaction: Specifics in case of BLIK transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `blik_id` string: Blik id - `giropay_transaction` GiropayTransaction: Specifics in case of Giropay transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `giropay_id` string: Giropay id - `ideal_transaction` IdealTransaction: Specifics in case of IDEAL transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `ideal_id` string: Ideal id - `p24_transaction` P24Transaction: Specifics in case of P24 transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `p24_id` string: P24 id - `sepa_transaction` SepaTransaction: Specifics in case of SEPA transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `sepa_id` string: SEPA id - `sepa_mandate` SepaMandate: SEPA Mandate - `iban` string: Mandate IBAN - `sepa_mandate_bank_reference` string, required: Bank reference - `sepa_ebics_transaction` SepaEbicsTransaction: Specifics in case of SEPA EBICS transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `sepa_ebics_id` string, required: SEPA EBICS id - `sepa_ebics_mandate` SepaEbicsMandate, required: SEPA EBICS mandate - `iban` string, required: Mandate IBAN - `sepa_mandate_bank_reference` string, required: Bank reference - `stripe_transaction` StripeTransaction: Specifics in case of Stripe transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `stripe_id` string: Stripe transaction id - `stripe_mandate` StripeMandate: Stripe mandate - `bic` string: Bank BIC/SWIFT code - `sepa_last4` string: Last 4 digits of SEPA IBAN - `trustly_transaction` TrustlyTransaction: Specifics in case of Trustly transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `trustly_id` string: Trustly id - `verkkopankki_transaction` VerkkopankkiTransaction: Specifics in case of Verkkopankki transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `verkkopankki_id` string: VerkkopankkiTransaction id - `eps_transaction` EpsTransaction: Specifics in case of Eps transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `eps_id` string: Eps id - `estonia_banks_transaction` EstoniaBanksTransaction: Specifics in case of Estonia Banks transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `estonia_banks_id` string: Estonia Banks id - `latvia_banks_transaction` LatviaBanksTransaction: Specifics in case of Latvia Banks transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `latvia_banks_id` string: Latvia Banks id - `lithuania_banks_transaction` LithuaniaBanksTransaction: Specifics in case of Lithuania Banks transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `lithuania_banks_id` string: Lithuania Banks id - `mbway_transaction` MbwayTransaction: Specifics in case of MB Way transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `mb_way_id` string: MB Way id - `multibanco_transaction` MultibancoTransaction: Specifics in case of Multibanco transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `multibanco_id` string: Multibanco id - `mybank_transaction` MybankTransaction: Specifics in case of MyBank transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `mybank_id` string: MyBank id - `payconiq_transaction` PayconiqTransaction: Specifics in case of Payconiq transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `payconiq_id` string: Payconiq id - `paysafecard_transaction` PaysafecardTransaction: Specifics in case of Paysafecard transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `paysafecard_id` string: Paysafecard id - `paysera_transaction` PayseraTransaction: Specifics in case of Paysera transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `paysera_id` string: Paysera id - `postfinance_transaction` PostfinanceTransaction: Specifics in case of PostFinance transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `postfinance_id` string: PostFinance id - `satispay_transaction` SatispayTransaction: Specifics in case of Satispay transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `satispay_id` string: Satispay id - `twint_transaction` TwintTransaction: Specifics in case of Twint transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `twint_id` string: Twint id - `twint_mandate` TwintMandate: Twint mandate used to initiate transaction when transaction is recurring - `wechatpay_transaction` WeChatPayTransaction: Specifics in case of WeChat Pay transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `wechatpay_id` string: WeChat Pay id - `wero_transaction` WeroTransaction: Specifics in case of Wero transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `wero_id` string: Wero transaction id - `mps_transaction` MpsTransaction: Specifics in case of MobilePay Subscriptions transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `mps_id` string, required: MobilePay Subscriptions id - `mps_subscription` MpsSubscription, required: MobilePay Subscriptions agreement - `id` string, required: Unique id for payment method - `state` 'active' | 'inactivated' | 'failed' | 'pending' | 'deleted', required: State of the payment method: `active`, `inactivated`, `failed`, `pending` or `deleted` - `customer` string, required: Customer by handle - `reference` string: Optional reference provided when creating the payment method. For payment methods created with Frisbii Checkout the reference will correspond to the session id for the Checkout session that created the payment method. - `failed` string, date-time: Date when the payment method failed. In ISO-8601 extended offset date-time format. - `created` string, date-time, required: Date when the payment method was created. In ISO-8601 extended offset date-time format. - `external_id` string: Optional external id at MobilePay defined when creating the subscription - `mps_payment_type` 'regular' | 'one_off_cit' | 'one_off_mit', required: MobilePay Subscriptions payment type: `regular`, `one_off_cit` (customer initiated), `one_off_mit` (merchant initiated auto reserve) - `vipps_epayment_transaction` VippsEpaymentTransaction: Specifics in case of Vipps ePayments transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `vipps_epayment_id` string, required: Vipps ePayment id - `vipps_recurring_transaction` VippsRecurringTransaction: Specifics in case of Vipps Recurring transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `vipps_recurring_id` string, required: Vipps Recurring id - `vipps_recurring_mandate` VippsRecurringMandate, required: Vipps Recurring mandate - `offline_transaction` OfflineTransaction: Specifics in case of Offline transaction - `error` string: Error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `ref_transaction` string: Id of a possible referenced transaction - `error_state` 'pending' | 'soft_declined' | 'hard_declined' | 'processing_error': Error state if failed: `pending`, `soft_declined`, `hard_declined` or `processing_error` - `acquirer_message` string: Acquirer message in case of error - `offline_mandate` OfflineMandate: Offline mandate used to initiated transaction when transaction is recurring - `offline_agreement_handle` string, required: Offline agreement handle - `offline_agreement_name` string: Optional offline agreement name - `offline_agreement_handle` string: Offline agreement handle used to initiate transaction. Only set when `offline_mandate` is not set - `offline_payment_instructions` string, required: Offline payment instructions, either default from agreement or overriding from charge parameters - `payment_due_date` string, date-time - `bank_reconciliation` BankReconciliation: Bank reconciliation status for a transaction - `state` 'open' | 'matched' | 'closed', required: State of the bank reconciliation - `opened` string, date-time: When the reconciliation became open, i.e. an eligible candidate (UTC). Absent when the transaction was closed without ever becoming a candidate. In [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `matched` string, date-time: When the reconciliation was matched to a bank statement line (UTC). In [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `closed` string, date-time: When the reconciliation was closed (UTC). In [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `test` boolean: Flag indicating the reconciliation was done using a test bank-data provider. Absent until the transaction has been matched. - `payment_context` string: Payment context describing if the transaction is customer or merchant initiated, one of the following values: `cit`, `mit`, `cit_cof` - `accounting_invoice` string: Accounting invoice number if this transaction belongs to an accounting invoice - `debtor_id` integer: Customer debtor id if this transaction belongs to an accounting invoice - `customer_handle` string: Customer handle if this transaction belongs to an accounting invoice - `dunning_start` string, date-time: When dunning for the invoice was started, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `dunning_count` integer: Number of dunning events for invoice (number of reminders sent) - `dunning_expired` string, date-time: When dunning for the invoice expired, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `period_from` string, date-time: The start of billing period if the invoice is for a specific billing period, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `period_to` string, date-time: The end of billing period if the invoice is for a specific billing period, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `settle_later` boolean: Whether this is a customer one-time invoice that will be settled later - `settle_later_payment_method` string: The payment method to use for a later settle of a one-time customer invoice - `billing_address` InvoiceBillingAddress: The subscription's own billing address. Overrides the customer's billing address on every invoice this subscription generates; the customer record is left unchanged. Omit to inherit the customer's address. - `company` string: Company name - `vat` string: Company vat number - `attention` string: Attention - `address` string: Address line 1 - `address2` string: Address line 2 - `city` string: City - `country` string: Country in ISO 3166-1 alpha-2 - `email` string: Email - `phone` string: Phone number - `first_name` string: First name - `last_name` string: Last name - `postal_code` string: Postal code - `state_or_province` string: State or province. Should be in country subdivision code defined in ISO 3166-2. - `shipping_address` InvoiceShippingAddress: The subscription's own shipping address. Overrides the customer's shipping address on every invoice this subscription generates; the customer record is left unchanged. Omit to inherit the customer's address. A billing address is never used as a shipping address. - `company` string: Company name - `vat` string: Company vat number - `attention` string: Attention - `address` string: Address line 1 - `address2` string: Address line 2 - `city` string: City - `country` string: Country in ISO 3166-1 alpha-2 - `email` string: Email - `phone` string: Phone number - `first_name` string: First name - `last_name` string: Last name - `postal_code` string: Postal code - `state_or_province` string: State or province. Should be in country subdivision code defined in ISO 3166-2. - `accounting_number` string: Invoice accounting number - `debtor_id` integer: Customer debtor id - `download_url` string: Link to the invoice or credit note PDF, available if PDF generation and accounting features are enabled (only for subscription invoices, not charges). Access requires authentication. See https://docs.frisbii.com/reference/authentication. The response is a binary PDF file. - `accounting_created_date` string, 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](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `invoice_file_type` 'pdf' | 'pdf_xml': The type of invoice file, e.g. `pdf` - `cost_center` string: Cost center for accounting purposes - `po_number` string: Purchase order number for accounting purposes - `sales_rep_id` string: Sales representative identifier - `order_id` string: Order identifier - `credit_notes` InvoiceCreditNote[]: Invoice credit notes - `id` string, required: Credit note id - `invoice` string, required: Invoice credited by this note - `transaction` string: Refund transaction id if credit note has an associated refund - `credit` string: Credit reference if the credit note relates to a subscription credit - `amount` integer, required: Credit note amount - `created` string, date-time, required: Creation date for note, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `currency` string, required: Credit note currency in [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) three letter alpha code - `customer` string, required: Customer handle - `subscription` string: Subscription handle, will be null for a one-time customer invoice - `amount_vat` integer, required: Credit note vat amount calculated as rounded summed fractional vats for each credit note lines - `amount_ex_vat` integer: Credit note total amount excluding VAT calculated as summed amounts excl. vats for each credit note lines - `credit_note_lines` CreditNoteLine[], required: Credit note lines - `amount` integer, required: Credit note line total amount - `text` string, required: Credit note line text - `description` string: Order line description - `quantity` integer, required: Credit note line quantity - `vat` number, float: Vat for this credit note line - `created` string, date-time: Creation date for this credit note line, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `origin` 'plan' | 'add_on' | 'ondemand' | 'additional_cost' | 'credit' | 'discount' | 'setup_fee' | 'surcharge_fee' | 'metered_billing_product': Order line origin, one of the following: `plan`, `add_on`, `ondemand`, `additional_cost`, `credit`, `discount`, `setup_fee`, `surcharge_fee`, `metered_billing_product` - `order_line_id` string: Reference to invoice orderline this credit note line relates to - `amount_incl_vat` integer: Credit note line total amount including VAT - `amount_ex_vat` integer: Credit note line total amount excluding VAT - `unit_amount` integer: Credit note line unit amount - `unit_amount_vat` integer: Credit note line vat amount - `unit_amount_ex_vat` integer: Credit note line unit amount excluding VAT - `amount_incl_vat_defined` boolean: Whether the total and units are including VAT. - `period_from` string, date-time: The start of billing period in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `period_to` string, date-time: The end of billing period in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `cost_object` string: Cost object number (Kostenträger-Nr.) this line is booked to - `accounting_number` string: Credit note accounting number - `debtor_id` integer: Customer debtor id - `download_url` string: Link to the credit note PDF, available if PDF generation and accounting features are enabled (only for subscription invoices, not charges). Access requires authentication. See https://docs.frisbii.com/reference/authentication. The response is a binary PDF file. - `accounting_created_date` string, 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](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `cost_center` string: Cost center for accounting purposes - `po_number` string: Purchase order number for accounting purposes - `sales_rep_id` string: Sales representative identifier - `order_id` string: Order identifier - `invoice_file_type` 'pdf' | 'pdf_xml': The type of invoice file, e.g. `pdf` - `account` Account - `handle` string, required: Per organisation unique handle for the account - `currency` string, required: Currency for the account in [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) three letter alpha code - `name` string, required: Account name - `address` string: Account address - `address2` string: Account address2 - `city` string: Account city - `locale` string, required: Account locale on the form 'language_country'. E.g. da_DK. Most major locales are supported. - `timezone` string, required: Account time zone ID as abbreviation or full name. E.g 'UTC' or 'Europe/Copenhagen'. See [Wikipedia](http://en.wikipedia.org/wiki/List_of_tz_database_time_zones) - `country` string, required: Account country in [ISO 3166-1 alpha-2](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). E.g. DK. - `email` string: Account email - `phone` string: Account phone - `vat` string: Account vat number - `website` string: Account website - `logo` string: Account logo url - `id` string, required: Account id assigned by Frisbii - `organisation` string, required: Organisation by subdomain - `created` string, date-time, required: Date when the account was created. In [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `state` 'test' | 'live' | 'closed', required: Status of the account one of the following `test`, `live`, `closed`. - `postal_code` string: Account postal code - `default_vat` number, float, required: Vat to use as default for account - `subscription_invoice_prefix` string: Subscription invoice prefix - `charge` Charge - `handle` string, required: Per account unique reference to charge/invoice. E.g. order id from own system. Multiple payments can be attempted for the same handle but only one succeeded charge can exist per handle. Max length 255 with allowable characters [a-zA-Z0-9_.-@]. - `state` 'created' | ' authorized' | 'settled' | 'failed' | 'cancelled' | 'pending', required: The charge state one of the following: `created`, `authorized`, `settled`, `failed`, `cancelled`, `pending`. A pending state after create charge indicates an async processing has been started for an asynchronous payment method. E.g. MobilePay Subscriptions. See also `processing`. The result of the charge will be delivered in webhook as either `invoice_authorized`, `invoice_settled` or `invoice_failed`. - `customer` string, required: Customer handle - `amount` integer, required: The invoice amount including VAT. If partial settles are performed amount represents the total settled amount. - `currency` string, required: Currency for the account in [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) three letter alpha code - `authorized` string, date-time: When the charge was authorized, if the charge went through an authorize and settle flow, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `settled` string, date-time: When the charge was settled, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `cancelled` string, date-time: When the charge was cancelled, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `created` string, date-time, required: When the invoice was created, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `transaction` string: Transaction id assigned by Frisbii. Assigned when transaction is performed. - `error` string: Frisbii error code if failed. See [transaction errors](https://docs.frisbii.com/reference/transaction_errors). - `processing` boolean: For asynchronous payment methods this flag indicates that the charge is awaiting result. The charge/invoice state will be pending. - `source` ChargeSource, required: Object describing the source for the charge. E.g. credit card. - `type` 'card_token' | 'card' | 'mpo' | 'vipps' | 'vipps_epayment' | 'vipps_recurring' | 'swish' | 'viabill' | 'anyday' | 'manual' | 'applepay' | 'googlepay' | 'paypal' | 'klarna' | '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' | 'sepa_ebics' | 'click_to_pay' | 'stripe_sepa', required: Type of charge source: `card` - existing customer card, `card_token` - card token, `mpo` - MobilePay Online, `vipps`, `vipps_epayment`, `vipps_recurring`, `swish`, `viabill`, `anyday`, `manual`, `applepay`, `googlepay`, `paypal`, `klarna`, `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`, or `verkkopankki`, `offline_cash`, `offline_bank_transfer`, `offline_other`, `sepa_ebics`, `click_to_pay`, `stripe_sepa` - `card` string: Reference to customer card if source type `card` - `mps` string: Reference to MobilePay Subscriptions payment method if source type `mobilepay_subscriptions` - `iban` string: IBAN number if source type `sepa` and `sepa_ebics` - `fingerprint` string: Uniquely identifies this particular card number if credit card source - `provider` 'reepay' | 'aibms' | 'bambora' | 'barclays' | 'clearhaus' | 'cmcic' | 'credibanco' | 'cs' | 'elavon' | 'evry' | 'first_data' | 'handelsbanken' | 'hsbc' | 'nets' | 'shift4' | 'spreedly' | 'swedbank' | 'thailand_kbank' | 'valitor' | 'worldline' | 'worldpay' | 'test': Card acquirer or card payment gateway used if card source: `reepay`, `aibms`, `bambora`, `barclays`, `clearhaus`, `cmcic`, `credibanco`, `cs`, `elavon`, `evry`, `first_data`, `handelsbanken`, `hsbc`, `nets`, `shift4`, `spreedly`, `swedbank`, `thailand_kbank`, `valitor`, `worldline`, `worldpay`, `test` - `frictionless` boolean: If the card transaction was exempted from a 3DS challenge - `vipps_recurring` string: Reference to Vipps Recurring Subscriptions payment method if source type `vipps_recurring` - `sepa_mandate` string: Reference to SEPA Mandate payment method if source type `sepa` - `sepa_ebics_mandate` string: Reference to SEPA EBICS Mandate payment method if source type `sepa_ebics` - `stripe_mandate` string: Reference to Stripe Mandate payment method if source type `stripe_sepa` - `twint_mandate` string: Reference to Twint Mandate payment method if source type `twint` - `paypal_mandate` string: Reference to PayPal Mandate payment method if source type `paypal` - `klarna_mandate` string: Reference to Klarna Mandate payment method if source type `klarna` - `offline_agreement_handle` string: Agreement handle if source type `offline_cash`, `offline_bank_transfer`, `offline_other` - `offline_payment_instructions` string: Offline payment instructions if source type `offline_cash`, `offline_bank_transfer`, `offline_other` - `auth_transaction` string: Reference to authorization transaction if charge is settled after authorization - `card_type` 'unknown' | 'visa' | 'mc' | 'dankort' | 'visa_dk' | 'ffk' | 'visa_elec' | 'maestro' | 'laser' | 'amex' | 'diners' | 'discover' | 'jcb' | 'china_union_pay': Card type if credit card source: `unknown`, `visa`, `mc`, `dankort`, `visa_dk`, `ffk`, `visa_elec`, `maestro`, `laser`, `amex`, `diners`, `discover`, `jcb` or `china_union_pay` - `transaction_card_type` 'unknown' | 'visa' | 'mc' | 'dankort' | 'visa_dk' | 'ffk' | 'visa_elec' | 'maestro' | 'laser' | 'amex' | 'diners' | 'discover' | 'jcb' | 'china_union_pay': Transaction card type if credit card source. Will differ from `card_type` if co-branded card. Transaction card type is the card type used for the transaction. `unknown`, `visa`, `mc`, `dankort`, `visa_dk`, `ffk`, `visa_elec`, `maestro`, `laser`, `amex`, `diners`, `discover`, `jcb` or `china_union_pay` - `exp_date` string: Card expire date on form MM-YY if credit card source - `masked_card` string: Masked card number if credit card source - `card_country` string: Card issuing country if credit card source, in [ISO 3166-1 alpha-2](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) - `strong_authentication_status` 'threed_secure' | 'threed_secure_not_enrolled' | 'secured_by_nets': Status for strong customer authentication: `threed_secure` - 3D Secure authenticated, `threed_secure_not_enrolled` - 3D Secure authentication not performed as card not enrolled, `secured_by_nets` - Secure by Nets authenticated - `three_d_secure_status` string: If 3D Secure authenticated the 3D status will either be `Y` (fully authenticated) or `A` (attempted authenticated). An attempted authentication means that card issuer (e.g. bank) does not support 3D Secure so no full authentication has been performed. Attempted authentication normally means liability shift, but this can differ between acquirers. - `risk_rule` string: If this parameter is set the charge has either been flagged or declined by a Frisbii Risk Filter rule. For flag action rules the charge can be successful, but may require special attention. For block action rules the decline error will be `risk_filter_block`. - `acquirer_code` string: Card acquirer error code in case of card error - `acquirer_message` string: Acquirer message in case of error - `acquirer_reference` string: Card acquirer reference to transaction in case of card source. E.g. Nets order id or Clearhaus reference. - `text_on_statement` string: Resulting text on bank statement if known - `surcharge_fee` integer: Potential card surcharge fee added to amount if surcharging enabled - `cardholder_name` string: Cardholder name if provided when entering credit card details - `ani_result` 'match' | 'partial_match' | 'no_match' | 'unverified' | 'not_supported': The result of the Account Name Inquiry (cardholder name verification) performed by the provider. Only relevant if cardholder name was provided and this transaction corresponds to a customer-initiated authorization or instant settle. - `order_lines` OrderLine[], required: Order lines for charge - `id` string, required: Per account unique order line id - `ordertext` string, required: Order line text - `amount` integer, required: Order line total amount including vat - `vat` number, float, required: Order line vat percent - `quantity` integer, required: Order line quantity - `origin` 'plan' | 'add_on' | 'ondemand' | 'additional_cost' | 'credit' | 'discount' | 'setup_fee' | 'surcharge_fee' | 'metered_billing_product', required: Order line origin, one of the following: `plan`, `add_on`, `ondemand`, `additional_cost`, `credit`, `discount`, `setup_fee`, `surcharge_fee`, `metered_billing_product` - `timestamp` string, date-time, required: Timestamp from order line origin, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `amount_vat` integer, required: Order line total vat amount - `amount_ex_vat` integer, required: Order line total amount without vat - `discounted_amount` integer: Order line amount after potential discount has been deducted, including vat - `discounted_amount_ex_vat` integer: Order line amount after potential discount has been deducted, excluding vat - `unit_amount` integer, required: Order line unit amount including vat - `unit_amount_vat` integer, required: Order line unit vat amount - `unit_amount_ex_vat` integer, required: Order line unit amount without vat - `amount_defined_incl_vat` boolean, required: Whether the amount was defined including VAT. E.g. plan amount defined including VAT. - `applied_tax_rule` 'reverse_charge' | 'intra_community_digital_service' | 'third_country' | 'fiscal_unity': Tax rule applied for order line indicates who is liable to account for the VAT. - `origin_handle` string: Handle for additional cost, credit, plan or subscription discount in the case one of those are the origin - `period_from` string, date-time: The start of billing period if the order line is a plan order line for a specific billing period, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `period_to` string, date-time: The end of billing period if the order line is a plan order line for a specific billing period, in [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `discount_percentage` integer: The discount percentage for discount order lines that has a percentage discount - `discounted_order_line` string: For discount order lines a reference to the order line for which the order line is a discount - `cost_object` string: Cost object number (Kostenträger-Nr.) this line is booked to - `refunded_amount` integer, required: Refunded amount - `authorized_amount` integer: Authorized amount if authorization was performed. The maximum amount that can be settled. - `error_state` 'soft_declined' | 'hard_declined' | 'processing_error': Frisbii error state if failed: `soft_declined`, `hard_declined` or `processing_error`. Soft and hard declines indicate a card decline. A soft decline is possibly recoverable and a subsequent request with the same card may succeed. E.g. insufficient funds. A processing error indicates an error processing the card either at Frisbii, the acquirer, or between Frisbii and the acquirer. - `recurring_payment_method` string: Optional reference to recurring payment method created in conjunction with charging - `billing_address` InvoiceBillingAddress: The subscription's own billing address. Overrides the customer's billing address on every invoice this subscription generates; the customer record is left unchanged. Omit to inherit the customer's address. - `company` string: Company name - `vat` string: Company vat number - `attention` string: Attention - `address` string: Address line 1 - `address2` string: Address line 2 - `city` string: City - `country` string: Country in ISO 3166-1 alpha-2 - `email` string: Email - `phone` string: Phone number - `first_name` string: First name - `last_name` string: Last name - `postal_code` string: Postal code - `state_or_province` string: State or province. Should be in country subdivision code defined in ISO 3166-2. - `shipping_address` InvoiceShippingAddress: The subscription's own shipping address. Overrides the customer's shipping address on every invoice this subscription generates; the customer record is left unchanged. Omit to inherit the customer's address. A billing address is never used as a shipping address. - `company` string: Company name - `vat` string: Company vat number - `attention` string: Attention - `address` string: Address line 1 - `address2` string: Address line 2 - `city` string: City - `country` string: Country in ISO 3166-1 alpha-2 - `email` string: Email - `phone` string: Phone number - `first_name` string: First name - `last_name` string: Last name - `postal_code` string: Postal code - `state_or_province` string: State or province. Should be in country subdivision code defined in ISO 3166-2. - `payment_context` string: Payment context describing if the transaction is customer or merchant initiated, one of the following values: `cit`, `mit`, `cit_cof` - `customer` Customer - `handle` string - `firstName` string - `lastName` string - `email` string - `phone` string - `country` string - `company` string - `vat` string - `subscription` Subscription - `handle` string, required: Per account unique handle for subscription - `customer` string, required: Customer handle - `plan` string, required: Subscription plan handle - `state` 'active' | 'expired' | 'on_hold' | 'pending', required: 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`. - `test` boolean, required: Test flag - `amount` integer: Optional custom plan price. If defined the plan price billed for each billing period will be overridden by this price. - `quantity` integer, required: Quantity of the plan product for this subscription. - `expires` string, date-time: Fixed date when the subscription will expire because of cancellation. In [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `reactivated` string, date-time: Date when the subscription was reactivated from on hold. [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `timezone` string, required: Time zone for the subscription as standard time zone id. See [Wikipedia](http://en.wikipedia.org/wiki/List_of_tz_database_time_zones) - `created` string, date-time, required: Date when the subscription was created. In [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `activated` string, 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](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `renewing` boolean, required: If the subscription renews at current period end. Also true for subscriptions with manual scheduling. - `coupons` string[]: List of coupon handles redeemed for the subscription - `currency` string, required: Currency for the subscription in [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) three letter alpha code - `plan_version` integer, required: Subscription plan version - `amount_incl_vat` boolean: Decides if the amount should or shouldn't include VAT. Overrides the parameter from the plan - `start_date` string, 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](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `end_date` string, date-time: Fixed end date and time. In [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `grace_duration` integer: 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. - `current_period_start` string, date-time: Start date and time for the current billing period. In [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `next_period_start` string, 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. - `first_period_start` string, date-time: Start date and time for the first ever billing period. In ISO-8601 extended offset date-time format. - `last_period_start` string, date-time: Start date and time for the previous billing period. In [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `trial_start` string, date-time: Start date and time of free trial period. In ISO-8601 extended offset date-time format. - `trial_end` string, date-time: End date and time of free trial period. In ISO-8601 extended offset date-time format. - `is_cancelled` boolean, required: Whether the subscription has been cancelled. Cancelled subscriptions will expire at the end of the current billing period. - `in_trial` 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. - `trial_extended_count` integer: How many times has the trial period been extended by changing the next period start. - `has_started` 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. - `renewal_count` integer, required: Number of renewals for the subscription (number of invoices) - `cancelled_date` string, date-time: Date when the subscription was cancelled. In [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `expired_date` string, date-time: Date when the subscription expired. [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `expire_reason` 'dunning' | 'cancelled' | 'ondemand' | 'fixed': Reason for expire. Can be `ondemand`, `cancelled`, `dunning` or `fixed` - `is_withdrawal_eligible` boolean: Whether the customer can currently withdraw from the subscription under the EU statutory right of withdrawal. True when the customer has no VAT ID, the customer's country is an EU member state or not set, and no more than 14 days have passed since the subscription was activated (or started). The subscription state is not taken into account. - `on_hold_date` string, date-time: Date when the subscription was put on hold. [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `on_hold_reason` 'dunning' | 'ondemand': Reason for on hold. Can be `ondemand` or `dunning` - `payment_method_added` boolean, required: Whether the customer at some point has added payment information to the subscription - `scheduled_plan_change` 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. - `reminder_email_sent` string, date-time: If defined the date a reminder email was sent for the current billing period. In [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `failed_invoices` integer, required: Number of failed invoices for this subscription - `failed_amount` integer, required: Summed amount for failed invoices - `cancelled_invoices` integer, required: Number of cancelled invoices for this subscription - `cancelled_amount` integer, required: Summed amount for cancelled invoices - `pending_invoices` integer, required: Number of pending invoices for this subscription - `pending_amount` integer, required: Summed amount for pending invoices - `dunning_invoices` integer, required: Number of dunning invoices for this subscription - `dunning_amount` integer, required: Summed amount for dunning invoices - `settled_invoices` integer, required: Number of settled invoices for this subscription - `settled_amount` integer, required: Summed settled amount - `refunded_amount` integer, required: Summed refunded amount - `pending_additional_costs` integer, required: Number of pending additional costs - `pending_additional_cost_amount` integer, required: Summed amount of pending additional costs incl vat - `transferred_additional_costs` integer, required: Number of additional costs that have been applied to invoices - `transferred_additional_cost_amount` integer, required: Summed amount of additional costs that have been applied to invoices - `pending_credits` integer, required: Number of credits that have not fully been applied to invoices - `pending_credit_amount` integer, required: Summed credit amount not yet applied to invoices - `transferred_credits` integer, required: Number of credits that have fully been applied to invoices - `transferred_credit_amount` integer, required: Summed credit amount that have been applied to invoices - `hosted_page_links` SubscriptionLinks, required: Links to hosted pages relating to subscription - `payment_info` string, required: 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` string[]: List of subscription discounts handles attached to subscription - `pending_change` SubscriptionChange: List of subscription changes both at most one pending and previously applied - `plan` string: The handle of the plan to change to - `amount` integer: Optional custom per quantity plan price. If provided the plan price billed for each billing period will be overridden by this price. - `quantity` integer: Optional quantity of the plan product for this subscription. If not provided the default is the default plan quantity defined for the plan. - `pending` boolean, required: Whether this is a pending change at next renewal, or it has been applied - `applied` string, date-time: If defined the change was applied on this date and time - `updated` string, date-time: Date and time of update of pending change - `created` string, date-time, required: Date when the change was created. In [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `plan_version` integer: The version of the plan to change to. If not provided the latest version of the plan will be used. - `amount_incl_vat` boolean: Whether the optional amount is including VAT. - `subscription_add_ons` SubscriptionAddOn[]: List of subscription add-ons to create in change - `handle` string, required: Per subscription unique handle for the subscription add-on. - `quantity` integer: Quantity of the subscription add-on. Only defined for quantity type add-ons - `amount` integer: Fixed subscription add-on per quantity price. If not defined the subscription add-on uses the add-on price. For a subscription add-on priced with its own single per-unit price this reports that price, also when it is configured as a pricing curve. Null for tiered/stepped pricing. - `name` string: Optional name overriding the add-on name. If not defined the add-on name will be used as order line text. - `description` string: Optional description overriding the add-on description. If not defined the add-on description will be used. - `created` string, date-time, required: Date when the subscription add-on was created. In ISO-8601 extended offset date-time format. - `currency` string, required: Currency for the subscription addon in [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) three letter alpha code. Always the currency of the add-on. - `add_on` AddOn, required: Add-on for subscription add-on - `name` string, required: Name of add-on. Will be used as order line text. - `description` string: Optional description of add-on - `amount` integer: Add-on amount. Required when no pricing block is provided. For add-ons priced with a single per-unit price this reports that price, also when it is configured as a pricing curve. Null for tiered/stepped pricing. - `vat` number, float: Optional vat for add-on. Account default is used if none given. - `type` 'on_off' | 'quantity', required: Add-on type `on_off` or `quantity`. An `on_off` type cannot be given a quantity when attached to subscription. For `quantity` type it is possible. Type can only be updated from `on_off` to `quantity`. It is not allowed to change type from `quantity` to `on_off`. - `handle` string, required: Per account unique handle for the add-on - `state` 'active' | 'deleted', required: Add-on state `active` or `deleted`. - `deleted` string, date-time: Date when the add-on was deleted if deleted. In ISO-8601 extended offset date-time format. - `created` string, date-time, required: Date when the add-on was created. In ISO-8601 extended offset date-time format. - `currency` string: Currency for the add-on in [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) three letter alpha code - `amount_incl_vat` boolean: Whether the amount is including VAT. Default true. - `tax_policy` string: Optional tax policy handle for add-on. Account default is used if none given. - `min_units` integer: Minimum allowed quantity for a `quantity` type add-on, at least 1. Only allowed when `type` is `quantity`. When the add-on is attached without a `quantity`, this value is used as the quantity. A lower quantity, when attaching the add-on or with `change_addon_quantity`, is rejected with error code 228 (`ADD_ON_QUANTITY_OUT_OF_RANGE`). - `max_units` integer: Maximum allowed quantity for a `quantity` type add-on, at least 1 and not lower than `min_units`. Only allowed when `type` is `quantity`. A higher quantity, when attaching the add-on or with `change_addon_quantity`, is rejected with error code 228 (`ADD_ON_QUANTITY_OUT_OF_RANGE`). - `all_plans` boolean: Whether all plans are eligible for this add-on. Defaults to false. - `eligible_plans` string[]: If not `all_plans` are set to true, then the set of eligible plan handles must be defined. - `entitlements` string[]: List of entitlement handles for the add-on. - `pricing` AddOnPricing: Pricing curve of an add-on or of a subscription add-on, used instead of a flat amount. Any pricing other than a `per_unit` model with a single range requires the `ADVANCED_ADDON_PRICING` entitlement, otherwise the request is rejected with HTTP 403 and error code 209 (`FEATURE_NOT_INCLUDED_IN_PLAN`). - `pricing_model` 'per_unit' | 'per_unit_step' | 'per_tier' | 'per_tier_step': Pricing model, applied to the quantity of the add-on: - `per_unit`: all units are charged at the price per unit of the range the quantity falls in. - `per_unit_step`: the units in each range are charged at that range's price per unit, and the charges are summed. - `per_tier`: a flat fee, the price of the range the quantity falls in, is charged regardless of the number of units. - `per_tier_step`: the flat fees of all ranges up to and including the one the quantity falls in are summed. The per-unit models scale with the number of units, the per-tier models charge a flat fee per range. Percentage models are not supported for add-ons. Required when `pricing` is given on an add-on. On a `custom` subscription add-on it defaults to the add-on's pricing model when omitted. - `unit_label` string: Label for the unit the add-on is priced in. Ignored while `unit_handle` links a unit. On a `custom` subscription add-on it defaults to the add-on's value when omitted. - `unit_handle` string: Handle of the unit of measure the pricing is linked to. While a unit is linked, the response reports the unit's names as `unit_label` and `unit_label_plural`, and the stored `unit_label` is ignored. Rejected for percentage pricing models. On update, `null` removes the link and leaving the field out keeps it. - `unit_label_plural` string: Plural name of the linked unit. Response only; left out when no unit is linked. - `unit_ranges` UnitRangeDto[]: Unit price ranges, in ascending order. The first range starts at 0, the ranges are contiguous (the `from` of a range is the `to` of the previous range plus 1) and only the last range may be open-ended (`to` not set). `price_per_unit` must not be negative. Required and not empty when `pricing` is given on a subscription add-on. - … - `cost_object` string: Cost object number (Kostenträger-Nr.) used for accounting export - `billing_period` 'day' | 'week' | 'month' | 'year': Billing period for the add-on. Defines the unit of the billing interval. Not set when the add-on is billed together with the subscription plan. Copied onto the subscription add-on when the add-on is attached. - `billing_interval_length` integer: Billing interval length for the add-on. Defines how many billing periods between each billing. Only applies when `billing_period` is set, where 1 is used if it is not set. Copied onto the subscription add-on when the add-on is attached. - `amount_incl_vat` boolean: If fixed price this parameter tells whether the amount is including VAT - `total_amount` integer: Total amount for the subscription add-on's configured quantity, computed server-side. Covers all pricing models (flat, per unit, per unit step, per tier and per tier step), respecting any amount or pricing overrides on the subscription add-on itself. Follows the same VAT inclusion as `amount_incl_vat` when set, otherwise the add-on's `amount_incl_vat`. - `billing_period` 'day' | 'week' | 'month' | 'year': Billing period for the subscription add-on, copied from the add-on when it was attached. Defines the unit of the billing interval. Not set when the add-on is billed together with the subscription plan. - `billing_interval_length` integer: Billing interval length for the subscription add-on, copied from the add-on when it was attached. Defines how many billing periods between each billing. Only applies when `billing_period` is set, where 1 is used if it is not set. - `next_period_start` string, date-time: Date when the next billing period for this subscription add-on starts. In ISO-8601 extended offset date-time format. Only maintained for an add-on with its own `billing_period`, where it may not be set before the add-on has first been billed. An add-on billed together with the subscription plan follows the `next_period_start` of the subscription. - `pricing` AddOnPricing: Pricing curve of an add-on or of a subscription add-on, used instead of a flat amount. Any pricing other than a `per_unit` model with a single range requires the `ADVANCED_ADDON_PRICING` entitlement, otherwise the request is rejected with HTTP 403 and error code 209 (`FEATURE_NOT_INCLUDED_IN_PLAN`). - `pricing_model` 'per_unit' | 'per_unit_step' | 'per_tier' | 'per_tier_step': Pricing model, applied to the quantity of the add-on: - `per_unit`: all units are charged at the price per unit of the range the quantity falls in. - `per_unit_step`: the units in each range are charged at that range's price per unit, and the charges are summed. - `per_tier`: a flat fee, the price of the range the quantity falls in, is charged regardless of the number of units. - `per_tier_step`: the flat fees of all ranges up to and including the one the quantity falls in are summed. The per-unit models scale with the number of units, the per-tier models charge a flat fee per range. Percentage models are not supported for add-ons. Required when `pricing` is given on an add-on. On a `custom` subscription add-on it defaults to the add-on's pricing model when omitted. - `unit_label` string: Label for the unit the add-on is priced in. Ignored while `unit_handle` links a unit. On a `custom` subscription add-on it defaults to the add-on's value when omitted. - `unit_handle` string: Handle of the unit of measure the pricing is linked to. While a unit is linked, the response reports the unit's names as `unit_label` and `unit_label_plural`, and the stored `unit_label` is ignored. Rejected for percentage pricing models. On update, `null` removes the link and leaving the field out keeps it. - `unit_label_plural` string: Plural name of the linked unit. Response only; left out when no unit is linked. - `unit_ranges` UnitRangeDto[]: Unit price ranges, in ascending order. The first range starts at 0, the ranges are contiguous (the `from` of a range is the `to` of the previous range plus 1) and only the last range may be open-ended (`to` not set). `price_per_unit` must not be negative. Required and not empty when `pricing` is given on a subscription add-on. - `from` integer, required: From value of the range (incl.). The first range starts at 0, and every following range starts at the `to` of the previous range plus 1. - `to` integer: To value of the range (incl.). If not set, the range is open ended, which is only allowed for the last range. - `price_per_unit` string, required: Price per unit in the range, a non-negative decimal string with up to 3 decimals. For the per-unit and per-tier pricing models it is an amount in major currency units, so `10.00` is 10 DKK. - `cost_object` string: Cost object number (Kostenträger-Nr.) used for accounting export - `pricing_strategy` 'fixed' | 'flexible' | 'custom': Pricing strategy for the subscription add-on's price. `fixed`: the add-on's pricing was snapshotted when it was attached and does not change afterwards. `flexible`: follows the add-on's live pricing. `custom`: the price was overridden with `amount` or `pricing` when attaching. For a subscription add-on attached before the strategy was recorded, it is derived from the stored price. - `compensation_method` 'none' | 'prorated' | 'full': When pending at renewal: `none`, `prorated`, or `full` (null defaults to `prorated` at application). Omitted when not set. - `remove_add_ons` string[]: Subscription add-ons to remove from subscription by subscription add-on handle - `fixation_period_end_date` string, date-time: Earliest possible cancellation date. In [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `notice_periods` integer: Optional number of notice periods for a cancel. The subscription will be cancelled for this number of full periods before expiring. Either from the cancellation date, or from the end of the the current period. See `notice_periods_after_current`. The default is to expire at the end of current period (0). A value of 1 (and `notice_periods_after_current` set to true) will for example result in a scenario where the subscription is cancelled until the end of current period, and then for the full subsequent period before expiring. - `notice_period_unit_type` 'day' | 'week' | 'month' | 'year': Time unit used in conjunction with notice periods - `contract_period_end_date` string, date-time: Contract period end date for the subscription - `contract_period_after_renewal_period` integer: Contract period after renewal - `contract_period_after_renewal_unit_type` 'day' | 'week' | 'month' | 'year': Time unit for the contract period after renewal - `subscription_changes` SubscriptionChange[]: List of subscription changes both at most one pending and previously applied - `plan` string: The handle of the plan to change to - `amount` integer: Optional custom per quantity plan price. If provided the plan price billed for each billing period will be overridden by this price. - `quantity` integer: Optional quantity of the plan product for this subscription. If not provided the default is the default plan quantity defined for the plan. - `pending` boolean, required: Whether this is a pending change at next renewal, or it has been applied - `applied` string, date-time: If defined the change was applied on this date and time - `updated` string, date-time: Date and time of update of pending change - `created` string, date-time, required: Date when the change was created. In [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `plan_version` integer: The version of the plan to change to. If not provided the latest version of the plan will be used. - `amount_incl_vat` boolean: Whether the optional amount is including VAT. - `subscription_add_ons` SubscriptionAddOn[]: List of subscription add-ons to create in change - `handle` string, required: Per subscription unique handle for the subscription add-on. - `quantity` integer: Quantity of the subscription add-on. Only defined for quantity type add-ons - `amount` integer: Fixed subscription add-on per quantity price. If not defined the subscription add-on uses the add-on price. For a subscription add-on priced with its own single per-unit price this reports that price, also when it is configured as a pricing curve. Null for tiered/stepped pricing. - `name` string: Optional name overriding the add-on name. If not defined the add-on name will be used as order line text. - `description` string: Optional description overriding the add-on description. If not defined the add-on description will be used. - `created` string, date-time, required: Date when the subscription add-on was created. In ISO-8601 extended offset date-time format. - `currency` string, required: Currency for the subscription addon in [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) three letter alpha code. Always the currency of the add-on. - `add_on` AddOn, required: Add-on for subscription add-on - `name` string, required: Name of add-on. Will be used as order line text. - `description` string: Optional description of add-on - `amount` integer: Add-on amount. Required when no pricing block is provided. For add-ons priced with a single per-unit price this reports that price, also when it is configured as a pricing curve. Null for tiered/stepped pricing. - `vat` number, float: Optional vat for add-on. Account default is used if none given. - `type` 'on_off' | 'quantity', required: Add-on type `on_off` or `quantity`. An `on_off` type cannot be given a quantity when attached to subscription. For `quantity` type it is possible. Type can only be updated from `on_off` to `quantity`. It is not allowed to change type from `quantity` to `on_off`. - `handle` string, required: Per account unique handle for the add-on - `state` 'active' | 'deleted', required: Add-on state `active` or `deleted`. - `deleted` string, date-time: Date when the add-on was deleted if deleted. In ISO-8601 extended offset date-time format. - `created` string, date-time, required: Date when the add-on was created. In ISO-8601 extended offset date-time format. - `currency` string: Currency for the add-on in [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) three letter alpha code - `amount_incl_vat` boolean: Whether the amount is including VAT. Default true. - `tax_policy` string: Optional tax policy handle for add-on. Account default is used if none given. - `min_units` integer: Minimum allowed quantity for a `quantity` type add-on, at least 1. Only allowed when `type` is `quantity`. When the add-on is attached without a `quantity`, this value is used as the quantity. A lower quantity, when attaching the add-on or with `change_addon_quantity`, is rejected with error code 228 (`ADD_ON_QUANTITY_OUT_OF_RANGE`). - `max_units` integer: Maximum allowed quantity for a `quantity` type add-on, at least 1 and not lower than `min_units`. Only allowed when `type` is `quantity`. A higher quantity, when attaching the add-on or with `change_addon_quantity`, is rejected with error code 228 (`ADD_ON_QUANTITY_OUT_OF_RANGE`). - `all_plans` boolean: Whether all plans are eligible for this add-on. Defaults to false. - `eligible_plans` string[]: If not `all_plans` are set to true, then the set of eligible plan handles must be defined. - `entitlements` string[]: List of entitlement handles for the add-on. - `pricing` AddOnPricing: Pricing curve of an add-on or of a subscription add-on, used instead of a flat amount. Any pricing other than a `per_unit` model with a single range requires the `ADVANCED_ADDON_PRICING` entitlement, otherwise the request is rejected with HTTP 403 and error code 209 (`FEATURE_NOT_INCLUDED_IN_PLAN`). - `pricing_model` 'per_unit' | 'per_unit_step' | 'per_tier' | 'per_tier_step': Pricing model, applied to the quantity of the add-on: - `per_unit`: all units are charged at the price per unit of the range the quantity falls in. - `per_unit_step`: the units in each range are charged at that range's price per unit, and the charges are summed. - `per_tier`: a flat fee, the price of the range the quantity falls in, is charged regardless of the number of units. - `per_tier_step`: the flat fees of all ranges up to and including the one the quantity falls in are summed. The per-unit models scale with the number of units, the per-tier models charge a flat fee per range. Percentage models are not supported for add-ons. Required when `pricing` is given on an add-on. On a `custom` subscription add-on it defaults to the add-on's pricing model when omitted. - `unit_label` string: Label for the unit the add-on is priced in. Ignored while `unit_handle` links a unit. On a `custom` subscription add-on it defaults to the add-on's value when omitted. - `unit_handle` string: Handle of the unit of measure the pricing is linked to. While a unit is linked, the response reports the unit's names as `unit_label` and `unit_label_plural`, and the stored `unit_label` is ignored. Rejected for percentage pricing models. On update, `null` removes the link and leaving the field out keeps it. - `unit_label_plural` string: Plural name of the linked unit. Response only; left out when no unit is linked. - `unit_ranges` UnitRangeDto[]: Unit price ranges, in ascending order. The first range starts at 0, the ranges are contiguous (the `from` of a range is the `to` of the previous range plus 1) and only the last range may be open-ended (`to` not set). `price_per_unit` must not be negative. Required and not empty when `pricing` is given on a subscription add-on. - … - `cost_object` string: Cost object number (Kostenträger-Nr.) used for accounting export - `billing_period` 'day' | 'week' | 'month' | 'year': Billing period for the add-on. Defines the unit of the billing interval. Not set when the add-on is billed together with the subscription plan. Copied onto the subscription add-on when the add-on is attached. - `billing_interval_length` integer: Billing interval length for the add-on. Defines how many billing periods between each billing. Only applies when `billing_period` is set, where 1 is used if it is not set. Copied onto the subscription add-on when the add-on is attached. - `amount_incl_vat` boolean: If fixed price this parameter tells whether the amount is including VAT - `total_amount` integer: Total amount for the subscription add-on's configured quantity, computed server-side. Covers all pricing models (flat, per unit, per unit step, per tier and per tier step), respecting any amount or pricing overrides on the subscription add-on itself. Follows the same VAT inclusion as `amount_incl_vat` when set, otherwise the add-on's `amount_incl_vat`. - `billing_period` 'day' | 'week' | 'month' | 'year': Billing period for the subscription add-on, copied from the add-on when it was attached. Defines the unit of the billing interval. Not set when the add-on is billed together with the subscription plan. - `billing_interval_length` integer: Billing interval length for the subscription add-on, copied from the add-on when it was attached. Defines how many billing periods between each billing. Only applies when `billing_period` is set, where 1 is used if it is not set. - `next_period_start` string, date-time: Date when the next billing period for this subscription add-on starts. In ISO-8601 extended offset date-time format. Only maintained for an add-on with its own `billing_period`, where it may not be set before the add-on has first been billed. An add-on billed together with the subscription plan follows the `next_period_start` of the subscription. - `pricing` AddOnPricing: Pricing curve of an add-on or of a subscription add-on, used instead of a flat amount. Any pricing other than a `per_unit` model with a single range requires the `ADVANCED_ADDON_PRICING` entitlement, otherwise the request is rejected with HTTP 403 and error code 209 (`FEATURE_NOT_INCLUDED_IN_PLAN`). - `pricing_model` 'per_unit' | 'per_unit_step' | 'per_tier' | 'per_tier_step': Pricing model, applied to the quantity of the add-on: - `per_unit`: all units are charged at the price per unit of the range the quantity falls in. - `per_unit_step`: the units in each range are charged at that range's price per unit, and the charges are summed. - `per_tier`: a flat fee, the price of the range the quantity falls in, is charged regardless of the number of units. - `per_tier_step`: the flat fees of all ranges up to and including the one the quantity falls in are summed. The per-unit models scale with the number of units, the per-tier models charge a flat fee per range. Percentage models are not supported for add-ons. Required when `pricing` is given on an add-on. On a `custom` subscription add-on it defaults to the add-on's pricing model when omitted. - `unit_label` string: Label for the unit the add-on is priced in. Ignored while `unit_handle` links a unit. On a `custom` subscription add-on it defaults to the add-on's value when omitted. - `unit_handle` string: Handle of the unit of measure the pricing is linked to. While a unit is linked, the response reports the unit's names as `unit_label` and `unit_label_plural`, and the stored `unit_label` is ignored. Rejected for percentage pricing models. On update, `null` removes the link and leaving the field out keeps it. - `unit_label_plural` string: Plural name of the linked unit. Response only; left out when no unit is linked. - `unit_ranges` UnitRangeDto[]: Unit price ranges, in ascending order. The first range starts at 0, the ranges are contiguous (the `from` of a range is the `to` of the previous range plus 1) and only the last range may be open-ended (`to` not set). `price_per_unit` must not be negative. Required and not empty when `pricing` is given on a subscription add-on. - `from` integer, required: From value of the range (incl.). The first range starts at 0, and every following range starts at the `to` of the previous range plus 1. - `to` integer: To value of the range (incl.). If not set, the range is open ended, which is only allowed for the last range. - `price_per_unit` string, required: Price per unit in the range, a non-negative decimal string with up to 3 decimals. For the per-unit and per-tier pricing models it is an amount in major currency units, so `10.00` is 10 DKK. - `cost_object` string: Cost object number (Kostenträger-Nr.) used for accounting export - `pricing_strategy` 'fixed' | 'flexible' | 'custom': Pricing strategy for the subscription add-on's price. `fixed`: the add-on's pricing was snapshotted when it was attached and does not change afterwards. `flexible`: follows the add-on's live pricing. `custom`: the price was overridden with `amount` or `pricing` when attaching. For a subscription add-on attached before the strategy was recorded, it is derived from the stored price. - `compensation_method` 'none' | 'prorated' | 'full': When pending at renewal: `none`, `prorated`, or `full` (null defaults to `prorated` at application). Omitted when not set. - `remove_add_ons` string[]: Subscription add-ons to remove from subscription by subscription add-on handle - `fixation_period_end_date` string, date-time: Earliest possible cancellation date. In [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `notice_periods` integer: Optional number of notice periods for a cancel. The subscription will be cancelled for this number of full periods before expiring. Either from the cancellation date, or from the end of the the current period. See `notice_periods_after_current`. The default is to expire at the end of current period (0). A value of 1 (and `notice_periods_after_current` set to true) will for example result in a scenario where the subscription is cancelled until the end of current period, and then for the full subsequent period before expiring. - `notice_period_unit_type` 'day' | 'week' | 'month' | 'year': Time unit used in conjunction with notice periods - `contract_period_end_date` string, date-time: Contract period end date for the subscription - `contract_period_after_renewal_period` integer: Contract period after renewal - `contract_period_after_renewal_unit_type` 'day' | 'week' | 'month' | 'year': Time unit for the contract period after renewal - `subscription_add_ons` string[]: List of subscription add-on handles attached to subscription - `active_payment_methods` string[]: A list of active payment method ids. This list will at most contain 1 item. - `metered_billing_products` string[]: List of usage-based billing products attached to the subscription - `fixation_period_end_date` string, date-time: Earliest possible cancellation date. In [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `notice_periods` integer: Optional number of notice periods for a cancel. The subscription will be cancelled for this number of full periods before expiring. Either from the cancellation date, or from the end of the the current period. See `notice_periods_after_current`. The default is to expire at the end of current period (0). A value of 1 (and `notice_periods_after_current` set to true) will for example result in a scenario where the subscription is cancelled until the end of current period, and then for the full subsequent period before expiring. - `notice_period_unit_type` 'day' | 'week' | 'month' | 'year': Time unit used in conjunction with notice periods - `contract_period_start_date` string, date-time: Contract period start date for the subscription - `contract_period_end_date` string, date-time: Contract period end date for the subscription - `contract_period_after_renewal_period` integer: Contract period after renewal for the subscription - `contract_period_after_renewal_unit_type` 'day' | 'week' | 'month' | 'year': Unit type for the contract period after renewal - `cost_center` string: Cost center for accounting purposes - `po_number` string: Purchase order number for accounting purposes - `cost_object` string: Cost object number (Kostenträger-Nr.) used for accounting export - `sales_rep_id` string: Sales representative identifier for accounting purposes - `order_id` string: Order identifier for accounting purposes - `billing_address` InvoiceBillingAddress: The subscription's own billing address. Overrides the customer's billing address on every invoice this subscription generates; the customer record is left unchanged. Omit to inherit the customer's address. - `company` string: Company name - `vat` string: Company vat number - `attention` string: Attention - `address` string: Address line 1 - `address2` string: Address line 2 - `city` string: City - `country` string: Country in ISO 3166-1 alpha-2 - `email` string: Email - `phone` string: Phone number - `first_name` string: First name - `last_name` string: Last name - `postal_code` string: Postal code - `state_or_province` string: State or province. Should be in country subdivision code defined in ISO 3166-2. - `shipping_address` InvoiceShippingAddress: The subscription's own shipping address. Overrides the customer's shipping address on every invoice this subscription generates; the customer record is left unchanged. Omit to inherit the customer's address. A billing address is never used as a shipping address. - `company` string: Company name - `vat` string: Company vat number - `attention` string: Attention - `address` string: Address line 1 - `address2` string: Address line 2 - `city` string: City - `country` string: Country in ISO 3166-1 alpha-2 - `email` string: Email - `phone` string: Phone number - `first_name` string: First name - `last_name` string: Last name - `postal_code` string: Postal code - `state_or_province` string: State or province. Should be in country subdivision code defined in ISO 3166-2. - `plan` Plan - `name` string, required: Name of the plan - `description` string: Description of the plan - `vat` number, float: Optional vat for this plan. Account default is used if none given. - `amount` integer, required: Amount for the plan in the smallest unit for the account currency - `quantity` integer: Optional default quantity of the subscription plan product for new subscriptions. Default is 1. - `prepaid` boolean: Subscriptions can either be prepaid where an amount is paid in advance, or the opposite. This setting only relates to handling of pause scenarios. - `handle` string, required: Per account unique handle for the subscription plan. Max length 255 with allowable characters [a-zA-Z0-9_.-@]. - `version` integer, required: Plan version - `state` 'active' | 'superseded' | 'deleted', required: State of the subscription plan one of the following: `active`, `superseded`, `deleted` - `currency` string, required: Currency for the subscription plan in [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) three letter alpha code - `created` string, date-time, required: Date when the subscription plan was created. In ISO-8601 extended offset date-time format. - `deleted` string, date-time: Date when the subscription plan was deleted. In ISO-8601 extended offset date-time format. - `dunning_plan` string: Dunning plan by handle to use for the subscription plan. Default dunning plan will be used if none given. - `tax_policy` string: Optional tax policy handle for this plan. If vat and tax policy is given, vat will be ignored. - `renewal_reminder_email_days` integer: Optional renewal reminder email settings. Number of days before next billing to send a reminder email. - `trial_reminder_email_days` integer: Optional end of trial reminder email settings. Number of days before end of trial to send a reminder email. - `partial_period_handling` 'bill_full' | 'bill_prorated' | 'bill_zero_amount' | 'no_bill': How to handle a potential initial partial billing period for fixed day scheduling. The options are to bill for a full period, bill prorated for the partial period, bill a zero amoumt, or not to consider the period before first fixed day a billing period. The default is to bill prorated. Options: `bill_full`, `bill_prorated`, `bill_zero_amount`, `no_bill`. - `include_zero_amount` boolean: Whether to add a zero amount order line to subscription invoices if plan amount is zero or the subscription overrides to zero amount. The default is to not include the line. If no other order lines are present the plan order line will be added. - `setup_fee` integer: Optional one-time setup fee billed with the first invoice or as a separate invoice depending on the setting `setup_fee_handling`. - `setup_fee_text` string: Optional invoice order text for the setup fee that - `setup_fee_handling` string: How the billing of the setup fee should be done. The options are: `first` - include setup fee as order line on the first scheduled invoice. `separate` - create a separate invoice for the setup fee, is appropriate if first invoice is not in conjunction with creation. `separate_conditional` - create a separate invoice for setup fee if the first invoice is not created in conjunction with the creation. Default is `first`. - `setup_fee_vat` number, float: Optional VAT for setup fee. Only returns the explicitly configured VAT rate, not the resolved rate from tax policy. Use effective_setup_fee_vat to see what will be used. - `setup_fee_tax_policy` string: Optional tax policy handle for setup fee. If both setup_fee_vat and setup_fee_tax_policy are configured, tax policy takes precedence. - `setup_fee_amount_incl_vat` boolean: Whether setup fee amount is including VAT. Only returns the explicitly configured value. Use effective_setup_fee_amount_incl_vat to see what will be used. - `partial_proration_days` boolean: For fixed day scheduling and prorated partial handling calculate prorated amount using whole days counting start day as a full day, or use by the minute proration calculation from start date time to the next period start. Default is true (whole days). - `fixed_trial_days` boolean: When using trial for fixed day scheduling use this setting to control if trial expires at midnight or the trial period is down to the minute. Default is true (trial until start of day). Trial in days can only be true if `partial_proration_days` is also set to true. - `minimum_prorated_amount` integer: When using prorated partial handling the prorated amount for plan and add-ons might result in very small amounts. A minimum prorated amount for plan and add-ons can be defined. If the prorated amount is below this minimum the amount will be changed to zero. - `account_funding` boolean: Indicates that Account Funding Transaction (AFT) is requested. - `cost_object` string: Cost object number (Kostenträger-Nr.) used for accounting export - `amount_incl_vat` boolean: Whether the amount is including VAT. Default true. - `fixed_count` integer: Fixed number of renewals for subscriptions using this plan. Equals the number of scheduled invoices. Default is no fixed amount of renewals. - `fixed_life_time_unit` 'months' | 'days': Time unit use for fixed life time - `fixed_life_time_length` integer: Optional fixed life time length for subscriptions using this plan. E.g. 12 months. Subscriptions will cancel after the fixed life time and expire when the active billing cycle ends. - `trial_interval_unit` 'months' | 'days': Time unit for free trial period - `trial_interval_length` integer: Optional free trial interval length. E.g. 1 monts. - `interval_length` integer: The length of intervals. E.g. every second month or every 14 days. - `schedule_type` 'manual' | 'daily' | 'weekly_fixedday' | 'month_startdate' | 'month_fixedday' | 'month_lastday', required: Scheduling type, one of the following: `manual`, `daily`, `weekly_fixedday`, `month_startdate`, `month_fixedday`, `month_lastday`. See documentation for descriptions of the different types. - `schedule_fixed_day` integer: If a fixed day scheduling type is used a fixed day must be provided. For months the allowed value is 1-28 for weeks it is 1-7 - `schedule_fixed_hour` integer: Fixed hour (0-23) for monthly and weekly fixed day schedules. If not null, subscription will be scheduled at this hour. - `base_month` integer: For fixed month schedule types the base month can be used to control which months are eligible for start of first billing period. The eligible months are calculated as `base_month + k * interval_length` up to 12. E.g. to use quaterly billing in the months jan-apr-jul-oct, `base_month` 1 and `interval_length` 3 can be used. If not defined the first fixed day will be used as start of first billing period. - `notice_periods` integer: Optional number of notice periods for a cancel. The subscription will be cancelled for this number of full periods before expiring. Either from the cancellation date, or from the end of the the current period. See `notice_periods_after_current`. The default is to expire at the end of current period (0). A value of 1 (and `notice_periods_after_current` set to true) will for example result in a scenario where the subscription is cancelled until the end of current period, and then for the full subsequent period before expiring. - `notice_periods_after_current` boolean: If notice periods is set, this option controls whether the number of full notice periods should start at the end of the current period, or run from cancellation date and result in a partial period with partial amount for the last period. The default is true. E.g. if set to false and `notice_periods = 1` then the subscription will be cancelled for exactly for one period from the cancellation time and a partial amount will be billed at the start of the next billing period. - `fixation_periods` integer: Optional number of fixation periods. Fixation periods will guarantee that a subscription will have this number of paid full periods before expiring after a cancel. Default is to have no requirement (0). - `fixation_periods_full` boolean: If fixation periods are defined, and the subscription can have a partial prorated first period, this parameter controls if the the last period should be full, or partial to give exactly `fixation_periods` paid periods. Default is false. - `entitlements` string[]: List of entitlement handles to be added to the plan - `fixation_period_unit_type` 'day' | 'week' | 'month' | 'year': Time unit use in conjunction with fixation periods. If not fulfilled, it falls back to fixed_life_time_unit - `notice_period_unit_type` 'day' | 'week' | 'month' | 'year': Time unit used in conjunction with notice periods. If not fulfilled, it falls back to plan schedule_type - `contract_period` integer: Optional contract period length. E.g. 12 months. - `contract_period_unit_type` 'day' | 'week' | 'month' | 'year': Time unit used for the contract period - `contract_period_after_renewal_period` integer: Optional contract period length after renewal. E.g. 6 months. - `contract_period_after_renewal_unit_type` 'day' | 'week' | 'month' | 'year': Time unit used for the contract period after renewal - `subscription_duration_type` 'auto_renew' | 'fixed_number_of_billing_cycles' | 'end_on_contract_end': Subscription duration type - `effective_setup_fee_vat` number, float: Read-only. The effective VAT rate that will be used for setup fee after applying fallback logic. Returns the country-specific rate from setup_fee_tax_policy if set, otherwise returns setup_fee_vat if set, otherwise falls back to plan vat. - `effective_setup_fee_amount_incl_vat` boolean: Read-only. Whether the setup fee amount is including VAT after applying fallback logic. Returns setup_fee_amount_incl_vat if set, otherwise falls back to plan amount_incl_vat. - `addOns` SubscriptionAddOn[] - `handle` string, required: Per subscription unique handle for the subscription add-on. - `quantity` integer: Quantity of the subscription add-on. Only defined for quantity type add-ons - `amount` integer: Fixed subscription add-on per quantity price. If not defined the subscription add-on uses the add-on price. For a subscription add-on priced with its own single per-unit price this reports that price, also when it is configured as a pricing curve. Null for tiered/stepped pricing. - `name` string: Optional name overriding the add-on name. If not defined the add-on name will be used as order line text. - `description` string: Optional description overriding the add-on description. If not defined the add-on description will be used. - `created` string, date-time, required: Date when the subscription add-on was created. In ISO-8601 extended offset date-time format. - `currency` string, required: Currency for the subscription addon in [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) three letter alpha code. Always the currency of the add-on. - `add_on` AddOn, required: Add-on for subscription add-on - `name` string, required: Name of add-on. Will be used as order line text. - `description` string: Optional description of add-on - `amount` integer: Add-on amount. Required when no pricing block is provided. For add-ons priced with a single per-unit price this reports that price, also when it is configured as a pricing curve. Null for tiered/stepped pricing. - `vat` number, float: Optional vat for add-on. Account default is used if none given. - `type` 'on_off' | 'quantity', required: Add-on type `on_off` or `quantity`. An `on_off` type cannot be given a quantity when attached to subscription. For `quantity` type it is possible. Type can only be updated from `on_off` to `quantity`. It is not allowed to change type from `quantity` to `on_off`. - `handle` string, required: Per account unique handle for the add-on - `state` 'active' | 'deleted', required: Add-on state `active` or `deleted`. - `deleted` string, date-time: Date when the add-on was deleted if deleted. In ISO-8601 extended offset date-time format. - `created` string, date-time, required: Date when the add-on was created. In ISO-8601 extended offset date-time format. - `currency` string: Currency for the add-on in [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) three letter alpha code - `amount_incl_vat` boolean: Whether the amount is including VAT. Default true. - `tax_policy` string: Optional tax policy handle for add-on. Account default is used if none given. - `min_units` integer: Minimum allowed quantity for a `quantity` type add-on, at least 1. Only allowed when `type` is `quantity`. When the add-on is attached without a `quantity`, this value is used as the quantity. A lower quantity, when attaching the add-on or with `change_addon_quantity`, is rejected with error code 228 (`ADD_ON_QUANTITY_OUT_OF_RANGE`). - `max_units` integer: Maximum allowed quantity for a `quantity` type add-on, at least 1 and not lower than `min_units`. Only allowed when `type` is `quantity`. A higher quantity, when attaching the add-on or with `change_addon_quantity`, is rejected with error code 228 (`ADD_ON_QUANTITY_OUT_OF_RANGE`). - `all_plans` boolean: Whether all plans are eligible for this add-on. Defaults to false. - `eligible_plans` string[]: If not `all_plans` are set to true, then the set of eligible plan handles must be defined. - `entitlements` string[]: List of entitlement handles for the add-on. - `pricing` AddOnPricing: Pricing curve of an add-on or of a subscription add-on, used instead of a flat amount. Any pricing other than a `per_unit` model with a single range requires the `ADVANCED_ADDON_PRICING` entitlement, otherwise the request is rejected with HTTP 403 and error code 209 (`FEATURE_NOT_INCLUDED_IN_PLAN`). - `pricing_model` 'per_unit' | 'per_unit_step' | 'per_tier' | 'per_tier_step': Pricing model, applied to the quantity of the add-on: - `per_unit`: all units are charged at the price per unit of the range the quantity falls in. - `per_unit_step`: the units in each range are charged at that range's price per unit, and the charges are summed. - `per_tier`: a flat fee, the price of the range the quantity falls in, is charged regardless of the number of units. - `per_tier_step`: the flat fees of all ranges up to and including the one the quantity falls in are summed. The per-unit models scale with the number of units, the per-tier models charge a flat fee per range. Percentage models are not supported for add-ons. Required when `pricing` is given on an add-on. On a `custom` subscription add-on it defaults to the add-on's pricing model when omitted. - `unit_label` string: Label for the unit the add-on is priced in. Ignored while `unit_handle` links a unit. On a `custom` subscription add-on it defaults to the add-on's value when omitted. - `unit_handle` string: Handle of the unit of measure the pricing is linked to. While a unit is linked, the response reports the unit's names as `unit_label` and `unit_label_plural`, and the stored `unit_label` is ignored. Rejected for percentage pricing models. On update, `null` removes the link and leaving the field out keeps it. - `unit_label_plural` string: Plural name of the linked unit. Response only; left out when no unit is linked. - `unit_ranges` UnitRangeDto[]: Unit price ranges, in ascending order. The first range starts at 0, the ranges are contiguous (the `from` of a range is the `to` of the previous range plus 1) and only the last range may be open-ended (`to` not set). `price_per_unit` must not be negative. Required and not empty when `pricing` is given on a subscription add-on. - `from` integer, required: From value of the range (incl.). The first range starts at 0, and every following range starts at the `to` of the previous range plus 1. - `to` integer: To value of the range (incl.). If not set, the range is open ended, which is only allowed for the last range. - `price_per_unit` string, required: Price per unit in the range, a non-negative decimal string with up to 3 decimals. For the per-unit and per-tier pricing models it is an amount in major currency units, so `10.00` is 10 DKK. - `cost_object` string: Cost object number (Kostenträger-Nr.) used for accounting export - `billing_period` 'day' | 'week' | 'month' | 'year': Billing period for the add-on. Defines the unit of the billing interval. Not set when the add-on is billed together with the subscription plan. Copied onto the subscription add-on when the add-on is attached. - `billing_interval_length` integer: Billing interval length for the add-on. Defines how many billing periods between each billing. Only applies when `billing_period` is set, where 1 is used if it is not set. Copied onto the subscription add-on when the add-on is attached. - `amount_incl_vat` boolean: If fixed price this parameter tells whether the amount is including VAT - `total_amount` integer: Total amount for the subscription add-on's configured quantity, computed server-side. Covers all pricing models (flat, per unit, per unit step, per tier and per tier step), respecting any amount or pricing overrides on the subscription add-on itself. Follows the same VAT inclusion as `amount_incl_vat` when set, otherwise the add-on's `amount_incl_vat`. - `billing_period` 'day' | 'week' | 'month' | 'year': Billing period for the subscription add-on, copied from the add-on when it was attached. Defines the unit of the billing interval. Not set when the add-on is billed together with the subscription plan. - `billing_interval_length` integer: Billing interval length for the subscription add-on, copied from the add-on when it was attached. Defines how many billing periods between each billing. Only applies when `billing_period` is set, where 1 is used if it is not set. - `next_period_start` string, date-time: Date when the next billing period for this subscription add-on starts. In ISO-8601 extended offset date-time format. Only maintained for an add-on with its own `billing_period`, where it may not be set before the add-on has first been billed. An add-on billed together with the subscription plan follows the `next_period_start` of the subscription. - `pricing` AddOnPricing: Pricing curve of an add-on or of a subscription add-on, used instead of a flat amount. Any pricing other than a `per_unit` model with a single range requires the `ADVANCED_ADDON_PRICING` entitlement, otherwise the request is rejected with HTTP 403 and error code 209 (`FEATURE_NOT_INCLUDED_IN_PLAN`). - `pricing_model` 'per_unit' | 'per_unit_step' | 'per_tier' | 'per_tier_step': Pricing model, applied to the quantity of the add-on: - `per_unit`: all units are charged at the price per unit of the range the quantity falls in. - `per_unit_step`: the units in each range are charged at that range's price per unit, and the charges are summed. - `per_tier`: a flat fee, the price of the range the quantity falls in, is charged regardless of the number of units. - `per_tier_step`: the flat fees of all ranges up to and including the one the quantity falls in are summed. The per-unit models scale with the number of units, the per-tier models charge a flat fee per range. Percentage models are not supported for add-ons. Required when `pricing` is given on an add-on. On a `custom` subscription add-on it defaults to the add-on's pricing model when omitted. - `unit_label` string: Label for the unit the add-on is priced in. Ignored while `unit_handle` links a unit. On a `custom` subscription add-on it defaults to the add-on's value when omitted. - `unit_handle` string: Handle of the unit of measure the pricing is linked to. While a unit is linked, the response reports the unit's names as `unit_label` and `unit_label_plural`, and the stored `unit_label` is ignored. Rejected for percentage pricing models. On update, `null` removes the link and leaving the field out keeps it. - `unit_label_plural` string: Plural name of the linked unit. Response only; left out when no unit is linked. - `unit_ranges` UnitRangeDto[]: Unit price ranges, in ascending order. The first range starts at 0, the ranges are contiguous (the `from` of a range is the `to` of the previous range plus 1) and only the last range may be open-ended (`to` not set). `price_per_unit` must not be negative. Required and not empty when `pricing` is given on a subscription add-on. - `from` integer, required: From value of the range (incl.). The first range starts at 0, and every following range starts at the `to` of the previous range plus 1. - `to` integer: To value of the range (incl.). If not set, the range is open ended, which is only allowed for the last range. - `price_per_unit` string, required: Price per unit in the range, a non-negative decimal string with up to 3 decimals. For the per-unit and per-tier pricing models it is an amount in major currency units, so `10.00` is 10 DKK. - `cost_object` string: Cost object number (Kostenträger-Nr.) used for accounting export - `pricing_strategy` 'fixed' | 'flexible' | 'custom': Pricing strategy for the subscription add-on's price. `fixed`: the add-on's pricing was snapshotted when it was attached and does not change afterwards. `flexible`: follows the add-on's live pricing. `custom`: the price was overridden with `amount` or `pricing` when attaching. For a subscription add-on attached before the strategy was recorded, it is derived from the stored price. - `discounts` SubscriptionDiscount[] - `handle` string, required: Per subscription unique handle for the subscription discount. - `discount` string, required: Discount for subscription discount - `state` 'active' | 'deleted', required: Discount state `active` or `deleted`. - `coupon` string: Coupon reference if this discount was released by a coupon code - `deleted` string, date-time: Date when the discount was deleted if deleted. In ISO-8601 extended offset date-time format. - `created` string, date-time, required: Date when the discount was created. In ISO-8601 extended offset date-time format. - `name` string: Optional name overriding the discount name. If not defined the discount name will be used as order line text. - `description` string: Optional description overriding the discount description. If not defined the discount description will be used. - `amount` integer: Fixed amount discount deducted from order line amounts including VAT - `currency` string: Currency of fixed amount discount in ISO 4217 three letter alpha code - `percentage` integer: Percentage discount applied to each applicable order line - `count` integer, required: Number of invoices this subscription discount has been applied to - `invoices` string[], required: List of invoices this subscription discount has been applied to - `discount_dto` Discount, required: Discount information related to the coupon code - `name` string, required: Name of discount. Will be used as order line text. - `description` string: Optional description of discount - `amount` integer: Fixed amount discount deducted from order line amounts including VAT, either amount or percentage should be provided - `currency` string: Currency for the discount plan in [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) three letter alpha code - `percentage` integer: Percentage discount applied to each applicable order line, either amount or percentage should be provided - `handle` string, required: Per account unique handle for the discount - `metadata` object: Custom metadata. - `state` 'active' | 'deleted', required: Discount state `active` or `deleted`. - `deleted` string, date-time: Date when the discount was deleted if deleted. In ISO-8601 extended offset date-time format. - `created` string, date-time, required: Date when the discount was created. In ISO-8601 extended offset date-time format. - `apply_to` string[], required: Which order lines the discount is applicable to: `all`, `setup_fee`, `plan`, `additional_cost`, `add_on`, `ondemand` and `metered_billing_product` - `fixed_count` integer: Apply discount to a fixed number of invoices - `fixed_period_unit` 'months' | 'days': Time unit use for fixed valid period either `days` or `months` - `fixed_period` integer: Fixed period length e.g. 12 months or 14 days - `apply_to` string[], required: Which order lines the discount is applicable to: `all`, `setup_fee`, `plan`, `additional_cost`, `add_on`, `ondemand` and `metered_billing_product` - `fixed_count` integer: Apply discount to a fixed number of invoices - `fixed_period_unit` 'months' | 'days': Time unit use for fixed valid period - `fixed_period` integer: Fixed period length e.g. 12 months or 14 days - `fixed_usage_reached` boolean, required: Whether fixed usage for subscription discount has been reached - `fixed_period_passed` boolean, required: Whether fixed period for subscription discount has been passed - `applicable_until` string, date-time, required: The date until this discount is or was applicable - `recurring` boolean - `createIntent` string - `settle` boolean - `surcharge` boolean - `pkey` string - `strongAuth` StrongAuth - `amount` integer - `currency` string - `orderId` string - `orderText` string - `merchantScaData` string - `paymentMethod` string - `pgwUrl` string - `mpoUrl` string - `mpoSessionToken` string - `mpoVersion` string - `mpsId` string - `mpsUrl` string - `viabillUrl` string - `anydayUrl` string - `anydayId` string - `payeverUrl` string - `payeverId` string - `vippsUrl` string - `vippsEpaymentId` string - `vippsEpaymentUrl` string - `vippsRecurringUrl` string - `vippsRecurringId` string - `pproUrl` string - `pproId` string - `stripeUrl` string - `applepayPaymentRequest` ApplepayPaymentRequestDto - `authUrl` string - `countryCode` string - `supportedNetworks` string[] - `merchantCapabilities` string - `currencyCode` string - `total` ApplepayLineItem - `label` string - `type` string - `amount` string - `paymentTiming` string - `recurringPaymentStartDate` string, date-time - `recurringPaymentIntervalUnit` string - `recurringPaymentIntervalCount` integer - `recurringPaymentEndDate` string, date-time - `createSessionUrl` string - `recurringPaymentRequest` ApplepayRecurringPaymentRequestDto - `paymentDescription` string - `regularBilling` ApplepayLineItem - `label` string - `type` string - `amount` string - `paymentTiming` string - `recurringPaymentStartDate` string, date-time - `recurringPaymentIntervalUnit` string - `recurringPaymentIntervalCount` integer - `recurringPaymentEndDate` string, date-time - `trialBilling` ApplepayLineItem - `label` string - `type` string - `amount` string - `paymentTiming` string - `recurringPaymentStartDate` string, date-time - `recurringPaymentIntervalUnit` string - `recurringPaymentIntervalCount` integer - `recurringPaymentEndDate` string, date-time - `managementURL` string - `tokenNotificationURL` string - `supportedCountries` string[] - `googlepayPaymentRequest` GooglepayPaymentRequestDto - `authUrl` string - `environment` string - `apiVersion` integer - `apiVersionMinor` integer - `merchantInfo` MerchantInfo - `merchantName` string - `merchantOrigin` string - `merchantId` string - `transactionInfo` TransactionInfo - `currencyCode` string - `totalPriceStatus` string - `totalPrice` string - `countryCode` string - `allowedPaymentMethods` AllowedPaymentMethod[] - `type` string - `parameters` AllowedPaymentMethodParameters - `allowedAuthMethods` string[] - `allowedCardNetworks` string[] - `tokenizationSpecification` TokenizationSpecification - `type` string - `parameters` TokenizationSpecificationParameters - `gateway` string - `gatewayMerchantId` string - `paypalClientId` string - `paypalPaymentRequest` object - `paypalAuthUrl` string - `paypalMerchantId` string - `paypalSetupToken` string - `paypalAttributionId` string - `paypalActionUrl` string - `paypalMetadataId` string - `klarnaClientToken` string - `klarnaMerchantData` string - `swishMobileToken` string - `swishId` string - `buttonText` string - `showSubscriptionDetails` boolean - `showTerms` boolean - `cardOnFile` CardOnFile - `paymentType` 'CARD' | 'ANYDAY' | 'APPLEPAY' | 'GOOGLEPAY' | 'PAYPAL' | 'SWISH' | 'VIABILL' | 'VIPPS' | 'VIPPS_RECURRING' | 'VIPPS_EPAYMENT' | 'MOBILEPAY' | 'MOBILEPAY_SUBSCRIPTIONS' | 'KLARNA' | 'KLARNA_PAY_NOW' | 'KLARNA_PAY_LATER' | 'KLARNA_SLICE_IT' | 'KLARNA_DIRECT_BANK_TRANSFER' | 'KLARNA_DIRECT_DEBIT' | 'RESURS' | 'EMV_TOKEN' | 'PP_BANCOMATPAY' | 'PP_BANCONTACT' | 'PP_BLIK' | 'PP_BLIK_OC' | 'PP_EPS' | 'PP_ESTONIA_BANKS' | 'PP_GIROPAY' | 'PP_IDEAL' | 'PP_LATVIA_BANKS' | 'PP_LITHUANIA_BANKS' | 'PP_MB_WAY' | 'PP_MULTIBANCO' | 'PP_MYBANK' | 'PP_P24' | 'PP_PAYCONIQ' | 'PP_PAYSAFECARD' | 'PP_PAYSERA' | 'PP_POSTFINANCE' | 'PP_SATISPAY' | 'PP_SEPA' | 'PP_TRUSTLY' | 'PP_TWINT' | 'PP_VERKKOPANKKI' | 'PP_WECHATPAY' | 'PP_WERO' | 'PE_SANTANDER' | 'MANUAL' | 'OFFLINE_BANK_TRANSFER' | 'OFFLINE_CASH' | 'OFFLINE_OTHER' | 'SEPA_EBICS' | 'STRIPE_SEPA' | 'CLICK_TO_PAY' | 'AGENTIC' - `cardType` string - `expDate` string - `maskedCard` string - `token` string - `requireCvv` boolean - `requireExpDate` boolean - `transactionCardType` string - `orderText` string - `recurringOptional` boolean - `recurringOptionalText` string - `recurringAverageAmount` integer - `partner` string - `expireDuration` integer - `mandateId` string - `viewMandateUrl` string - `showTestHints` boolean - `verification` Verification - `redirectUrl` string - `sessionId` string - `result` 'CREATED' | 'VERIFIED' | 'FAILED' - `iban` string - `bic` string - `verificationAge` VerificationAge - `redirectUrl` string - `sessionId` string - `result` 'CREATED' | 'MINIMUM_AGE_VERIFIED' | 'BELOW_MINIMUM_AGE' | 'FAILED' - `agreementFilter` string[] - `showSubscriptionDetailsExpanded` boolean - `currency` string - `consentDefinitions` ConsentDefinitionDto[] - `text` string, required: Text of the consent definition that should be rendered. The text supports templates for policies handles. - `policies` PolicyDefinitionDto[]: List of policy handles that are used in the text of the consent definition. - `handle` string, required: Per account unique identifier for the policy - `name` string, required: Name of the policy - `custom_name` string: Custom name that should be rendered in the consent definition instead of the defined name - `sessionReturnUrlType` 'DEFAULT' | 'BROWSER' | 'APP' - `minimumUserAge` integer - `requireCardholderName` boolean - `billingAddress` InvoiceBillingAddress: The subscription's own billing address. Overrides the customer's billing address on every invoice this subscription generates; the customer record is left unchanged. Omit to inherit the customer's address. - `company` string: Company name - `vat` string: Company vat number - `attention` string: Attention - `address` string: Address line 1 - `address2` string: Address line 2 - `city` string: City - `country` string: Country in ISO 3166-1 alpha-2 - `email` string: Email - `phone` string: Phone number - `first_name` string: First name - `last_name` string: Last name - `postal_code` string: Postal code - `state_or_province` string: State or province. Should be in country subdivision code defined in ISO 3166-2. ## Other responses - `400`: Invalid request, see error codes at https://api.frisbii.com/v1/error_codes - `404`: Resource or referenced resource not found, see error codes at https://api.frisbii.com/v1/error_codes - `500`: Internal service error, error is reported automatically to Frisbii --- [API](https://skmtc.dev/frisbii/apis/frisbii-checkout-api.md) - [All operations](https://skmtc.dev/frisbii/apis/frisbii-checkout-api/llms.txt) - [OpenAPI document](https://skmtc.dev/frisbii/apis/frisbii-checkout-api/revisions/43015ffd9dbb?raw)