Create Subscription Order

Path

POST /businesses/{businessCode}/customers/{customerNumber}/orders

Request Parameters

businessCode

required

string

Business Code

customerNumber

required

string

External customer reference

X-Request-ID

string

The unique ID of this particular request/transaction. Subsequent requests with the same request ID might get ignored.

Request Body

application/json

required

object

array

One or more campaign/vouchers reference strings applicable for the order

currency

required

string

Currency used in order (encoded as 3-letter code according to ISO 4217)

deliveryType

string

Max length: 100

Enum:

NORMAL

EXPRESS

PICKUP

SAMEDAY

LOWCOST

Delivery type. Possible values: NORMAL, EXPRESS, PICKUP, SAMEDAY, LOWCOST

externalContractId

string

Max length: 40

External Contract ID

array

additionalInvoiceInformation

string

Max length: 255

Additional information for the invoice

description

string

Max length: 50

Name or title of product

grossUnitPrice

number

Gross unit price (incl. VAT) of item

quantity

number

Quantity (e.g. 2 pieces or 2.5 kg)

vatAmount

number

Tax value of country tax

vatPercent

number

Tax rate of country tax in %

array

netUnitPrice

number

Net unit price (w/o VAT) of item

array

additionalInvoiceInformation

string

Max length: 255

Additional information for the invoice

array

amountGrossDiscounts

number

Gross amount of discounts in Euro

amountNetDiscounts

number

Net amount of discounts in Euro

chargeMode

number

Charge Mode. Possible values : one-time, monthly, Usage-based, Per invoice if active, Per active license, Billing periods monthly

currency

string

Currency.

grossAmount

number

Gross amount of charge in Euro

localisedDisplayValue

string

Localised display value of the charge.

netAmount

number

Net amount of charge in Euro

pricedEvent

boolean

Client sends in the charge with the order as it is dependent on situation, e.g. speeding ticket.

salesOrganisation

string

Market or country.

taxRateType

string

Enum:

TAXLESS

NORMAL

REDUCED

Tax rate type: Possible values: NORMAL, TAXLESS, REDUCED

validFromDate

string

Valid From Date of the Charge.

validToDate

string

Valid to Date of the Charge.

vatAmount

number

Amount of taxes in Euro

vatPercent

number

Tax rate applied in %

description

string

Max length: 100

Description of option

externalContractId

string

Max length: 40

External Contract ID

productID

required

string

Max length: 100

External specific reference for option

proofURL

string

Max length: 255

Proof URL of the extra fees

quantity

integer

Max length: 100

Quantity of options in line item

productID

string

Max length: 100

ID of the specific product or SKU

orderChannel

string

Max length: 100

Enum:

ECOM

POS

APP

MOBILE

MOTO

P2P

Order channel, possible value: ECOM, POS, APP, MOBILE, MOTO, P2P

orderDate

string

yyyy-MM-dd

Date the order has been placed

orderReference

required

string

Max length: 16

Specific order reference from merchant (alphanumeric characters, only)

object

totalGrossAmount

number

Total gross amount

totalNetAmount

number

Total net amount

basketId

required

string

Max length: 10

Specific basket reference

orderReference

string

Max length: 10

External order reference

object

accountCategory

string

Enum:

Standard

Reseller

Account Category. Possible values are Standard, Reseller. Default value is Standard.

currency

string

Currency in which account is billed.

dataFromDefault

boolean

Flag to be set false only when basic account data needs to be explicitly updated. When it is set to true, basic data of account will be inherited from default account of the customer.

string

Max length: 241

Email address of the account to which invoice has to be billed.

emailFromDefault

boolean

Flag to be set false only when email needs to be explicitly updated. When it is set to true,email will be inherited from default account of the customer.

firstName

string

Max length: 40

First name to which invoice has to be billed.

identificationNumber

string

Max length: 20

Identification nummber to which invoice has to be billed.

lastName

string

Max length: 40

Last name to which invoice has to be billed.

ownerConsumption

boolean

If the account has the owner consumption status.

object

Contains information about a registered payment

object

Bank Account info is needed only in case of SEPA payment. EITHER PSP details OR bank account should be provided BUT NOT both.

string

Payment identification

paymentDataFromDefault

boolean

Flag to be set false only when paymentRegistration data needs to be explicitly updated. When it is set to true,payment Resgistration will be inherited from default account of the customer.

paymentMethodName

string

Enum:

AfterPayDirectDebit

AfterPayInstallmentsDirectDebit

AfterPayInstallmentsOpenInvoice

AfterPayOpenInvoice

AmazonPay

AmericanExpress

ApplePayExpressCheckout

ArvatoDirectDebitSepa

Bancontact

Blik

BlikCodeOnly

CashOnDelivery

DinersClub

Discover

Eps

Giftcard

Giropay

GooglePay

Ideal

InAppAmazon

InAppApple

InAppGoogle

InStoreOpenInvoice

InStorePickup

InStorePrepayment

Klarna

KlarnaDirectDebit

KlarnaInstallments

KlarnaOpenInvoice

KlarnaPayLater

KlarnaPayOverTime

LoyaltyCard

MasterCard

Multibanco

OpenInvoice

PayPal

PayPalExpressCheckout

PayU

PrePayment

Przelewy24

Sofort

Trustly

Visa

Name of the payment method being used: * AfterPayDirectDebit * AfterPayInstallmentsDirectDebit * AfterPayInstallmentsOpenInvoice * AfterPayOpenInvoice * AmazonPay * AmericanExpress * ApplePayExpressCheckout * ArvatoDirectDebitSepa * Bancontact * Blik * BlikCodeOnly * CashOnDelivery * DinersClub * Discover * Eps * Giftcard * Giropay * GooglePay * Ideal * InAppAmazon * InAppApple * InAppGoogle * InStoreOpenInvoice * InStorePickup * InStorePrepayment * Klarna * KlarnaDirectDebit * KlarnaInstallments * KlarnaOpenInvoice * KlarnaPayLater * KlarnaPayOverTime * LoyaltyCard * MasterCard * Multibanco * OpenInvoice * PayPal * PayPalExpressCheckout * PayU * PrePayment * Przelewy24 * Sofort * Trustly * Visa

pspCustomerId

string

PSP Customer identification

pspPaymentMethodId

string

PSP Payment method Id

salutation

string

Enum:

MRS

Salutation of the natural person: * MR = Mr * MRS = Mrs

taxExemption

string

Enum:

Disabled

Enabled

If there is any taxExemption for the account. Possible values are Disabled, Enabled. Default value is Disabled.

taxIdentificationNumber

string

TAX Identification nummber of the country to which invoice has to be billed.

accountId

required

string

Identificationnumber of that account

accountName

string

Name of that account

defaultAccount

boolean

This is a flag internal to our Subscription management System.There is just one default account internally created by the system and any further accounts created by merchants could never be default account. Setting this value to true is not possible.

object

Contains information about a transaction

object

Object that contains error-related information

array

object

A collection of PSP specific parameters

status

string

Transaction status for authorization

stripePaymentIntentId

string

Stripe Payment Intent Id of the customer

token

string

Transaction token for authorization

totalCapturedAmount

number

Total captured amount so far, potentially 0

totalRefundedAmount

number

Total refunded amount so far, potentially 0

Responses

array

customerNumber

integer

customer number defined by Arvato

example

object

externalCustomerReference

string

External customer number defined by Merchant

externalSignUpReference

string

External SignUp reference

signUpId

required

integer

SignupID