redocly logo API docs by Redocly

plenigo customer API v1 (C.240827-MINOR)

Download OpenAPI specification:Download

URL: https://support.plenigo.com

This is the API description for accessing the plenigo customer API.

AccessRights

Check access

Check if customer has a valid access right for one or multiple access rights identified by the provided access right unique ids.

Authorizations:
sessionToken
query Parameters
accessRightUniqueIds
required
string

comma separated ids of access right unique ids

Responses

Response samples

Content type
application/json
{
  • "customerId": "100003",
  • "customerBlocked": false,
  • "accessGranted": true,
  • "items": [
    ]
}

Addresses

Search addresses

Search all addresses that correspond to the given search conditions.

Authorizations:
sessionToken
query Parameters
size
integer <int32> [ 5 .. 100 ]

amount of elements to return - if no size is provided or the size is not within range it will be automatically set to 5

startTime
string <date-time>

time the entity was changed after or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

endTime
string <date-time>

time the entity was changed before or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

startingAfter
string <= 100 characters

A cursor for use in pagination. startingAfter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include startingAfter=obj_foo in order to fetch the next result set.

endingBefore
string <= 100 characters

A cursor for use in pagination. endingBefore is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include endingBefore=obj_bar in order to fetch the previous page of the list.

sort
string <= 4 characters
Enum: "ASC" "DESC"

The sort of the search, if its desc it will revert to search for a lower startingAfter

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Create address

Create a new address with the data provided.

Authorizations:
sessionToken
Request Body schema: application/json
type
required
string
Enum: "INVOICE" "DELIVERY"

address type

customerId
required
string^[0-9]{1,18}$

unique id of the customer the address belongs to

preferred
boolean

flag indicating if address is default selection for address type

businessAddress
boolean

flag indicating if address represents a private or a business address

salutation
string
Enum: "DIVERSE" "MR" "MRS" "NONE"

salutation to identify the correct designation of a customer

title
string <= 100 characters

title of the customer

firstName
string <= 100 characters

first name of the customer - first name and last name or company name are required

lastName
string <= 100 characters

last name of the customer - first name and last name or company name are required

companyName
string <= 100 characters

company name - first name and last name or company name are required

additionalCompanyInfo
string <= 100 characters

additional information belonging to the company

street
string <= 100 characters

street name

streetNumber
string <= 100 characters

street number

additionalStreetInfo
string <= 100 characters

additional information describing address

postbox
string <= 100 characters

postbox id

postcode
string <= 100 characters

postcode

city
string <= 100 characters

city

state
string <= 2 characters

state

country
string = 2 characters

country code formatted as ISO 3166-1 alpha-2

vatNumber
string <= 20 characters

VAT number of a member country of the European Union

phoneNumber
string <= 100 characters ^\+?[1-9]\d{1,14}$

phone number of the customer formatted as E.164

deliveryInformation
string <= 100 characters

delivery information

academicTitle
string <= 100 characters

academic title

jobPosition
string <= 100 characters

job position

validationStatus
string
Enum: "NONE" "VALID" "INVALID" "SUSPECT" "OVERRIDDEN"

validation status of the address

validationHash
string

validation hash of a valid address

Responses

Request samples

Content type
application/json
{
  • "type": "INVOICE",
  • "preferred": true,
  • "customerId": "100003",
  • "businessAddress": true,
  • "salutation": "MR",
  • "title": "Dr",
  • "firstName": "John",
  • "lastName": "Doe",
  • "companyName": "ARAMARK Ltd.",
  • "additionalCompanyInfo": "Subdivision of World Ltd.",
  • "street": "Commercial Road",
  • "streetNumber": "30",
  • "additionalStreetInfo": "Level 5",
  • "postcode": "PO1 1AA",
  • "city": "Hampshire",
  • "country": "GB",
  • "vatNumber": "DE123456789"
}

Response samples

Content type
application/json
{
  • "addressId": 100001,
  • "changedDate": "2019-03-21T17:32:12Z",
  • "type": "INVOICE",
  • "preferred": true,
  • "customerId": "100003",
  • "businessAddress": true,
  • "salutation": "MR",
  • "title": "Dr",
  • "firstName": "John",
  • "lastName": "Doe",
  • "companyName": "ARAMARK Ltd.",
  • "additionalCompanyInfo": "Subdivision of World Ltd.",
  • "street": "Commercial Road",
  • "streetNumber": "30",
  • "additionalStreetInfo": "Level 5",
  • "postcode": "PO1 1AA",
  • "city": "Hampshire",
  • "country": "GB",
  • "vatNumber": "DE123456789"
}

Get address

Get address that is identified by the passed address id.

Authorizations:
sessionToken
path Parameters
addressId
required
integer <int64>

unique id of the address

Responses

Response samples

Content type
application/json
{
  • "addressId": 100001,
  • "changedDate": "2019-03-21T17:32:12Z",
  • "type": "INVOICE",
  • "preferred": true,
  • "customerId": "100003",
  • "businessAddress": true,
  • "salutation": "MR",
  • "title": "Dr",
  • "firstName": "John",
  • "lastName": "Doe",
  • "companyName": "ARAMARK Ltd.",
  • "additionalCompanyInfo": "Subdivision of World Ltd.",
  • "street": "Commercial Road",
  • "streetNumber": "30",
  • "additionalStreetInfo": "Level 5",
  • "postcode": "PO1 1AA",
  • "city": "Hampshire",
  • "country": "GB",
  • "vatNumber": "DE123456789"
}

Update address

Update an address that is identified by the passed address id with the data provided. If fields were filled before and are now passed empty these fields will be cleared.

Authorizations:
sessionToken
path Parameters
addressId
required
integer <int64>

unique id of the address

Request Body schema: application/json
preferred
boolean

flag indicating if address is default selection for address type

businessAddress
boolean

flag indicating if address represents a private or a business address

salutation
string
Enum: "DIVERSE" "MR" "MRS" "NONE"

salutation to identify the correct designation of a customer

title
string <= 100 characters

title of the customer

firstName
string <= 100 characters

first name of the customer - first name and last name or company name are required

lastName
string <= 100 characters

last name of the customer - first name and last name or company name are required

companyName
string <= 100 characters

company name - first name and last name or company name are required

additionalCompanyInfo
string <= 100 characters

additional information belonging to the company

street
string <= 100 characters

street name

streetNumber
string <= 100 characters

street number

additionalStreetInfo
string <= 100 characters

additional information describing address

postbox
string <= 100 characters

postbox id

postcode
string <= 100 characters

postcode

city
string <= 100 characters

city

state
string <= 2 characters

state

country
string = 2 characters

country code formatted as ISO 3166-1 alpha-2

vatNumber
string <= 20 characters

VAT number of a member country of the European Union

phoneNumber
string <= 100 characters ^\+?[1-9]\d{1,14}$

phone number of the customer formatted as E.164

deliveryInformation
string <= 100 characters

delivery information

academicTitle
string <= 100 characters

academic title

jobPosition
string <= 100 characters

job position

validationStatus
string
Enum: "NONE" "VALID" "INVALID" "SUSPECT" "OVERRIDDEN"

validation status of the address

validationHash
string

validation hash of a valid address

Responses

Request samples

Content type
application/json
{
  • "preferred": true,
  • "businessAddress": true,
  • "salutation": "MR",
  • "title": "Dr",
  • "firstName": "John",
  • "lastName": "Doe",
  • "companyName": "ARAMARK Ltd.",
  • "additionalCompanyInfo": "Subdivision of World Ltd.",
  • "street": "Commercial Road",
  • "streetNumber": "30",
  • "additionalStreetInfo": "Level 5",
  • "postcode": "PO1 1AA",
  • "city": "Hampshire",
  • "country": "GB",
  • "vatNumber": "DE123456789"
}

Response samples

Content type
application/json
{
  • "addressId": 100001,
  • "changedDate": "2019-03-21T17:32:12Z",
  • "type": "INVOICE",
  • "preferred": true,
  • "customerId": "100003",
  • "businessAddress": true,
  • "salutation": "MR",
  • "title": "Dr",
  • "firstName": "John",
  • "lastName": "Doe",
  • "companyName": "ARAMARK Ltd.",
  • "additionalCompanyInfo": "Subdivision of World Ltd.",
  • "street": "Commercial Road",
  • "streetNumber": "30",
  • "additionalStreetInfo": "Level 5",
  • "postcode": "PO1 1AA",
  • "city": "Hampshire",
  • "country": "GB",
  • "vatNumber": "DE123456789"
}

Delete address

Delete an address that is identified by the passed address id. Only addresses that are not associated with a subscription can be deleted. If such an address shall be deleted it must first be disconnected from the subscription.

Authorizations:
sessionToken
path Parameters
addressId
required
integer <int64>

unique id of the address

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Get future addresses

Get all future addresses that correspond to the given address id.

Authorizations:
sessionToken
path Parameters
addressId
required
integer <int64>

unique id of the address

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Create future address

Create a new future address with the data provided. An address can only have two future addresses

Authorizations:
sessionToken
path Parameters
addressId
required
integer <int64>

unique id of the address

date
required
string <date>

date of the future address

query Parameters
overrideValidation
boolean

flag if the validation should be ignored

Request Body schema: application/json
businessAddress
boolean

flag indicating if address represents a private or a business address

salutation
string
Enum: "DIVERSE" "MR" "MRS" "NONE"

salutation to identify the correct designation of a customer

title
string <= 100 characters

title of the customer

firstName
string <= 100 characters

first name of the customer - first name and last name or company name are required

lastName
string <= 100 characters

last name of the customer - first name and last name or company name are required

companyName
string <= 100 characters

company name - first name and last name or company name are required

additionalCompanyInfo
string <= 100 characters

additional information belonging to the company

street
string <= 100 characters

street name

streetNumber
string <= 100 characters

street number

additionalStreetInfo
string <= 100 characters

additional information describing address

postbox
string <= 100 characters

postbox id

postcode
string <= 100 characters

postcode

city
string <= 100 characters

city

state
string <= 2 characters

state

country
string = 2 characters

country code formatted as ISO 3166-1 alpha-2

vatNumber
string <= 20 characters

VAT number of a member country of the European Union

phoneNumber
string <= 100 characters ^\+?[1-9]\d{1,14}$

phone number of the customer formatted as E.164

deliveryInformation
string <= 100 characters

delivery information

academicTitle
string <= 100 characters

academic title

jobPosition
string <= 100 characters

job position

validationStatus
string
Enum: "NONE" "VALID" "INVALID" "SUSPECT" "OVERRIDDEN"

validation status of the address

validationHash
string

validation hash of a valid address

Responses

Request samples

Content type
application/json
{
  • "businessAddress": true,
  • "salutation": "MR",
  • "title": "Dr",
  • "firstName": "John",
  • "lastName": "Doe",
  • "companyName": "ARAMARK Ltd.",
  • "additionalCompanyInfo": "Subdivision of World Ltd.",
  • "street": "Commercial Road",
  • "streetNumber": "30",
  • "additionalStreetInfo": "Level 5",
  • "postcode": "PO1 1AA",
  • "city": "Hampshire",
  • "country": "GB",
  • "vatNumber": "DE123456789"
}

Response samples

Content type
application/json
{
  • "activationDate": "2019-03-21",
  • "businessAddress": true,
  • "salutation": "MR",
  • "title": "Dr",
  • "firstName": "John",
  • "lastName": "Doe",
  • "companyName": "ARAMARK Ltd.",
  • "additionalCompanyInfo": "Subdivision of World Ltd.",
  • "street": "Commercial Road",
  • "streetNumber": "30",
  • "additionalStreetInfo": "Level 5",
  • "postcode": "PO1 1AA",
  • "city": "Hampshire",
  • "country": "GB",
  • "vatNumber": "DE123456789"
}

Update future address

Update a future address that is identified by the passed date with the data provided. If fields were filled before and are now passed empty these fields will be cleared.

Authorizations:
sessionToken
path Parameters
addressId
required
integer <int64>

unique id of the address

date
required
string <date>

date of the future address

query Parameters
overrideValidation
boolean

flag if the validation should be ignored

Request Body schema: application/json
businessAddress
boolean

flag indicating if address represents a private or a business address

salutation
string
Enum: "DIVERSE" "MR" "MRS" "NONE"

salutation to identify the correct designation of a customer

title
string <= 100 characters

title of the customer

firstName
string <= 100 characters

first name of the customer - first name and last name or company name are required

lastName
string <= 100 characters

last name of the customer - first name and last name or company name are required

companyName
string <= 100 characters

company name - first name and last name or company name are required

additionalCompanyInfo
string <= 100 characters

additional information belonging to the company

street
string <= 100 characters

street name

streetNumber
string <= 100 characters

street number

additionalStreetInfo
string <= 100 characters

additional information describing address

postbox
string <= 100 characters

postbox id

postcode
string <= 100 characters

postcode

city
string <= 100 characters

city

state
string <= 2 characters

state

country
string = 2 characters

country code formatted as ISO 3166-1 alpha-2

vatNumber
string <= 20 characters

VAT number of a member country of the European Union

phoneNumber
string <= 100 characters ^\+?[1-9]\d{1,14}$

phone number of the customer formatted as E.164

deliveryInformation
string <= 100 characters

delivery information

academicTitle
string <= 100 characters

academic title

jobPosition
string <= 100 characters

job position

validationStatus
string
Enum: "NONE" "VALID" "INVALID" "SUSPECT" "OVERRIDDEN"

validation status of the address

validationHash
string

validation hash of a valid address

Responses

Request samples

Content type
application/json
{
  • "businessAddress": true,
  • "salutation": "MR",
  • "title": "Dr",
  • "firstName": "John",
  • "lastName": "Doe",
  • "companyName": "ARAMARK Ltd.",
  • "additionalCompanyInfo": "Subdivision of World Ltd.",
  • "street": "Commercial Road",
  • "streetNumber": "30",
  • "additionalStreetInfo": "Level 5",
  • "postcode": "PO1 1AA",
  • "city": "Hampshire",
  • "country": "GB",
  • "vatNumber": "DE123456789"
}

Response samples

Content type
application/json
{
  • "activationDate": "2019-03-21",
  • "businessAddress": true,
  • "salutation": "MR",
  • "title": "Dr",
  • "firstName": "John",
  • "lastName": "Doe",
  • "companyName": "ARAMARK Ltd.",
  • "additionalCompanyInfo": "Subdivision of World Ltd.",
  • "street": "Commercial Road",
  • "streetNumber": "30",
  • "additionalStreetInfo": "Level 5",
  • "postcode": "PO1 1AA",
  • "city": "Hampshire",
  • "country": "GB",
  • "vatNumber": "DE123456789"
}

Delete future address

Delete a future address that is identified by the passed date.

Authorizations:
sessionToken
path Parameters
addressId
required
integer <int64>

unique id of the address

date
required
string <date>

date of the future address

Responses

Response samples

Content type
application/json
{
  • "success": true
}

App Stores

Search Apple purchases

Search all Apple purchases that correspond to the given search conditions.

Authorizations:
sessionToken
query Parameters
size
integer <int32> [ 5 .. 100 ]

amount of elements to return - if no size is provided or the size is not within range it will be automatically set to 5

startTime
string <date-time>

time the entity was changed after or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

endTime
string <date-time>

time the entity was changed before or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

startingAfter
string <= 100 characters

A cursor for use in pagination. startingAfter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include startingAfter=obj_foo in order to fetch the next result set.

endingBefore
string <= 100 characters

A cursor for use in pagination. endingBefore is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include endingBefore=obj_bar in order to fetch the previous page of the list.

sort
string <= 4 characters
Enum: "ASC" "DESC"

The sort of the search, if its desc it will revert to search for a lower startingAfter

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get Apple purchase

Get details for an Apple app store purchase.

Authorizations:
sessionToken
path Parameters
appleAppStorePurchaseId
required
integer <int64>

unique id of the purchase

Responses

Response samples

Content type
application/json
{
  • "appleAppStorePurchaseId": 0,
  • "purchaseDate": "2019-08-24T14:15:22Z",
  • "token": "string",
  • "valid": true,
  • "appStoreOrderId": 0,
  • "receipt": {
    },
  • "purchaseData": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "changedDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "createdByType": "API",
  • "changedBy": "string",
  • "changedByType": "API"
}

Search Google Playstore purchases

Search all Google Playstore purchases that correspond to the given search conditions.

Authorizations:
sessionToken
query Parameters
size
integer <int32> [ 5 .. 100 ]

amount of elements to return - if no size is provided or the size is not within range it will be automatically set to 5

startTime
string <date-time>

time the entity was changed after or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

endTime
string <date-time>

time the entity was changed before or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

startingAfter
string <= 100 characters

A cursor for use in pagination. startingAfter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include startingAfter=obj_foo in order to fetch the next result set.

endingBefore
string <= 100 characters

A cursor for use in pagination. endingBefore is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include endingBefore=obj_bar in order to fetch the previous page of the list.

sort
string <= 4 characters
Enum: "ASC" "DESC"

The sort of the search, if its desc it will revert to search for a lower startingAfter

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get Google Playstore purchase

Get details for a Google Playstore purchase.

Authorizations:
sessionToken
path Parameters
googlePlayStorePurchaseId
required
integer <int64>

unique id of the purchase

Responses

Response samples

Content type
application/json
{
  • "googlePlayStorePurchaseId": 0,
  • "purchaseDate": "2019-08-24T14:15:22Z",
  • "token": "string",
  • "packageName": "string",
  • "productId": "string",
  • "valid": true,
  • "subscription": true,
  • "purchaseToken": "string",
  • "appStoreOrderId": 0,
  • "subscriptionPurchase": {
    },
  • "productPurchase": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "changedDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "createdByType": "API",
  • "changedBy": "string",
  • "changedByType": "API"
}

Search app store order

Search all app store orders that correspond to the given search conditions.

Authorizations:
sessionToken
query Parameters
size
integer <int32> [ 5 .. 100 ]

amount of elements to return - if no size is provided or the size is not within range it will be automatically set to 5

startTime
string <date-time>

time the entity was changed after or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

endTime
string <date-time>

time the entity was changed before or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

startingAfter
string <= 100 characters

A cursor for use in pagination. startingAfter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include startingAfter=obj_foo in order to fetch the next result set.

endingBefore
string <= 100 characters

A cursor for use in pagination. endingBefore is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include endingBefore=obj_bar in order to fetch the previous page of the list.

sort
string <= 4 characters
Enum: "ASC" "DESC"

The sort of the search, if its desc it will revert to search for a lower startingAfter

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get app store order

Get details for an app store order.

Authorizations:
sessionToken
path Parameters
appStoreOrderId
required
integer <int64>

unique id of the app store order

Responses

Response samples

Content type
application/json
{
  • "appStoreOrderId": 0,
  • "orderDate": "2019-08-24T14:15:22Z",
  • "customerId": "string",
  • "storeType": "APPSTORE",
  • "additionalStoreData": {
    },
  • "items": [
    ],
  • "createdDate": "2019-08-24T14:15:22Z",
  • "changedDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "createdByType": "API",
  • "changedBy": "string",
  • "changedByType": "API"
}

Search app store subscription

Search all app store subscriptions that correspond to the given search conditions.

Authorizations:
sessionToken
query Parameters
size
integer <int32> [ 5 .. 100 ]

amount of elements to return - if no size is provided or the size is not within range it will be automatically set to 5

startTime
string <date-time>

time the entity was changed after or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

endTime
string <date-time>

time the entity was changed before or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

startingAfter
string <= 100 characters

A cursor for use in pagination. startingAfter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include startingAfter=obj_foo in order to fetch the next result set.

endingBefore
string <= 100 characters

A cursor for use in pagination. endingBefore is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include endingBefore=obj_bar in order to fetch the previous page of the list.

sort
string <= 4 characters
Enum: "ASC" "DESC"

The sort of the search, if its desc it will revert to search for a lower startingAfter

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get app store subscription

Get details for an app store subscription.

Authorizations:
sessionToken
path Parameters
appStoreSubscriptionId
required
integer <int64>

unique id of the app store subscription

Responses

Response samples

Content type
application/json
{
  • "appStoreSubscriptionId": 0,
  • "chainId": 0,
  • "externalSystemId": "string",
  • "customerId": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "cancellationDate": "2019-08-24T14:15:22Z",
  • "status": "ACTIVE",
  • "accessRightUniqueId": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "changedDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "createdByType": "API",
  • "changedBy": "string",
  • "changedByType": "API"
}

Commons

Get snippet design data

Returns snippet design data

path Parameters
companyId
required
string

unique id of a company

Responses

Response samples

Content type
application/json
{
  • "backgroundColor": "string",
  • "firstColor": "string",
  • "secondColor": "string",
  • "font": "string",
  • "fontColor": "string",
  • "linkColor": "string",
  • "snippetCss": "string",
  • "snippetJavaScript": "string"
}

Corporate Accounts

Search corporate accounts

Search all corporate accounts that correspond to the given search conditions.

Authorizations:
sessionToken
query Parameters
size
integer <int32> [ 5 .. 100 ]

amount of elements to return - if no size is provided or the size is not within range it will be automatically set to 5

startTime
string <date-time>

time the entity was changed after or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

endTime
string <date-time>

time the entity was changed before or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

startingAfter
string <= 100 characters

A cursor for use in pagination. startingAfter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include startingAfter=obj_foo in order to fetch the next result set.

endingBefore
string <= 100 characters

A cursor for use in pagination. endingBefore is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include endingBefore=obj_bar in order to fetch the previous page of the list.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get corporate account

Get the corporate account of the customer.

Authorizations:
sessionToken
path Parameters
corporateAccountId
required
integer <int64>

unique id of the corporate account

Responses

Response samples

Content type
application/json
{
  • "corporateAccountId": 9310,
  • "customerId": "100003",
  • "title": "A new offer",
  • "plenigoOfferId": "O_123456789123456789",
  • "usersAmount": 5,
  • "users": [
    ],
  • "accessRightItems": [
    ]
}

Create corporate account user

Create a corporate account user for the given corporate account.

Authorizations:
sessionToken
path Parameters
corporateAccountId
required
integer <int64>

unique id of the corporate account

query Parameters
sendMail
boolean

flag indicating if an email should be send

Request Body schema: application/json
email
required
string <email> <= 100 characters

email address of the customer that should belong to this corporate account user

salutation
required
string
Enum: "DIVERSE" "MR" "MRS" "NONE"

salutation to identify the correct designation of a customer

firstName
required
string <= 100 characters

first name of the customer - first name and last name or company name are required

lastName
required
string <= 100 characters

last name of the customer - first name and last name or company name are required

Responses

Request samples

Content type
application/json
{
  • "email": "wildflower@example.com",
  • "salutation": "MR",
  • "firstName": "John",
  • "lastName": "Doe"
}

Response samples

Content type
application/json
{
  • "corporateAccountId": 9310,
  • "customerId": "100003",
  • "title": "A new offer",
  • "plenigoOfferId": "O_123456789123456789",
  • "usersAmount": 5,
  • "users": [
    ],
  • "accessRightItems": [
    ]
}

Delete corporate account user

Delete a corporate account user for the given corporate account.

Authorizations:
sessionToken
path Parameters
corporateAccountId
required
integer <int64>

unique id of the corporate account

corporateAccountUserId
required
integer <int64>

unique id of the corporate account user

Responses

Response samples

Content type
application/json
{
  • "corporateAccountId": 9310,
  • "customerId": "100003",
  • "title": "A new offer",
  • "plenigoOfferId": "O_123456789123456789",
  • "usersAmount": 5,
  • "users": [
    ],
  • "accessRightItems": [
    ]
}

Resend invitation email

Resend a corporate account user invitation email for the given corporate account.

Authorizations:
sessionToken
path Parameters
corporateAccountId
required
integer <int64>

unique id of the corporate account

corporateAccountUserId
required
integer <int64>

unique id of the corporate account user

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Validate

Check if a corporate account user code is valid.

Authorizations:
sessionToken
Request Body schema: application/json
code
required
string [ 16 .. 19 ] characters

unique code for the corporate account user

Responses

Request samples

Content type
application/json
{
  • "code": "1234-5678-9123-4567"
}

Response samples

Content type
application/json
{
  • "corporateAccountId": 9310,
  • "plenigoOfferId": "O_123456789123456789",
  • "status": "INVITED"
}

Use corporate account code

Use a corporate account user code.

Authorizations:
sessionToken
Request Body schema: application/json
code
required
string [ 16 .. 19 ] characters

unique code for the corporate account user

Responses

Request samples

Content type
application/json
{
  • "code": "1234-5678-9123-4567"
}

Response samples

Content type
application/json
{
  • "errorCode": 99400,
  • "errorMessage": "Provided data cannot be processed.",
  • "validationErrors": [
    ]
}

Foreign Orders

Search customer's foreign orders

Search all foreign orders that correspond to the given search conditions and belong to the customer.

Authorizations:
sessionToken
query Parameters
size
integer <int32> [ 5 .. 100 ]

amount of elements to return - if no size is provided or the size is not within range it will be automatically set to 5

startTime
string <date-time>

time the entity was changed after or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

endTime
string <date-time>

time the entity was changed before or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

startingAfter
string <= 100 characters

A cursor for use in pagination. startingAfter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include startingAfter=obj_foo in order to fetch the next result set.

endingBefore
string <= 100 characters

A cursor for use in pagination. endingBefore is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include endingBefore=obj_bar in order to fetch the previous page of the list.

sort
string <= 4 characters
Enum: "ASC" "DESC"

The sort of the search, if its desc it will revert to search for a lower startingAfter

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Invoices

Search invoices

Search all invoices that correspond to the given search conditions.

Authorizations:
sessionToken
query Parameters
size
integer <int32> [ 5 .. 100 ]

amount of elements to return - if no size is provided or the size is not within range it will be automatically set to 5

startTime
string <date-time>

time the entity was changed after or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

endTime
string <date-time>

time the entity was changed before or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

startingAfter
string <= 100 characters

A cursor for use in pagination. startingAfter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include startingAfter=obj_foo in order to fetch the next result set.

endingBefore
string <= 100 characters

A cursor for use in pagination. endingBefore is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include endingBefore=obj_bar in order to fetch the previous page of the list.

sort
string <= 4 characters
Enum: "ASC" "DESC"

The sort of the search, if its desc it will revert to search for a lower startingAfter

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get PDF

Retrieve base64 encoded invoice pdf file for a given invoice id.

Authorizations:
sessionToken
path Parameters
invoiceId
required
integer <int64>

unique id of the invoice

Responses

Response samples

Content type
application/json
{
  • "pdf": "string"
}

Get xml

Retrieve xml formatted invoice file for a given invoice id.

Authorizations:
sessionToken
path Parameters
invoiceId
required
integer <int64>

unique id of the invoice

Responses

Response samples

Content type
application/json
{
  • "xml": "string"
}

Orders

Search orders

Search all orders that correspond to the given search conditions.

Authorizations:
sessionToken
query Parameters
size
integer <int32> [ 5 .. 100 ]

amount of elements to return - if no size is provided or the size is not within range it will be automatically set to 5

startTime
string <date-time>

time the entity was changed after or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

endTime
string <date-time>

time the entity was changed before or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

startingAfter
string <= 100 characters

A cursor for use in pagination. startingAfter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include startingAfter=obj_foo in order to fetch the next result set.

endingBefore
string <= 100 characters

A cursor for use in pagination. endingBefore is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include endingBefore=obj_bar in order to fetch the previous page of the list.

sort
string <= 4 characters
Enum: "ASC" "DESC"

The sort of the search, if its desc it will revert to search for a lower startingAfter

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get order item voucher PDF

Get pdf file that contains the order item voucher represented by the passed order id.

Authorizations:
sessionToken
path Parameters
orderId
required
integer <int64>

unique id of the order

orderItemPosition
required
integer <int>

position of the order item

Responses

Response samples

Content type
application/json
{
  • "pdf": "string"
}

Resend the order item voucher email to customer.

Resend the order item voucher email to the customer.

Authorizations:
sessionToken
path Parameters
orderId
required
integer <int64>

unique id of the order

orderItemPosition
required
integer <int>

position of the order item

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Get purchased addon

Get purchased addon that is identified by the passed address id.

Authorizations:
sessionToken
path Parameters
purchasedAddonId
required
integer <int64>

unique id of the purchase addon

Responses

Response samples

Content type
application/json
{
  • "purchasedAddonId": 0,
  • "deliveryCustomerId": "string",
  • "addonType": "BONUS",
  • "plenigoAddonId": "stringstringstringst",
  • "accessRightUniqueId": "string",
  • "orderId": 0,
  • "orderItemPosition": 0,
  • "status": "CANCELLED",
  • "deliveryCondition": "AFTER_PAYMENT",
  • "deliveryDate": "2019-08-24T14:15:22Z",
  • "trackingData": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "changedDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "createdByType": "API",
  • "changedBy": "string",
  • "changedByType": "API"
}

Payment Methods

Search payment methods

Search all payment methods that correspond to the given search conditions.

Authorizations:
sessionToken

Responses

Response samples

Content type
application/json
{
  • "amazonPayAccounts": [
    ],
  • "bankAccounts": [
    ],
  • "creditCards": [
    ],
  • "payPalAccounts": [
    ]
}

Allowed payment methods for offer

Get all allowed payment methods for a specific offer.

Authorizations:
sessionToken
path Parameters
plenigoOfferId
required
string

plenigo offer id

Responses

Response samples

Content type
application/json
{
  • "allowedPaymentMethods": [
    ]
}

Search AmazonPay accounts

Search all AmazonPay accounts accounts that correspond to the given search conditions.

Authorizations:
sessionToken
query Parameters
size
integer <int32> [ 5 .. 100 ]

amount of elements to return - if no size is provided or the size is not within range it will be automatically set to 5

startTime
string <date-time>

time the entity was changed after or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

endTime
string <date-time>

time the entity was changed before or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

startingAfter
string <= 100 characters

A cursor for use in pagination. startingAfter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include startingAfter=obj_foo in order to fetch the next result set.

endingBefore
string <= 100 characters

A cursor for use in pagination. endingBefore is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include endingBefore=obj_bar in order to fetch the previous page of the list.

sort
string <= 4 characters
Enum: "ASC" "DESC"

The sort of the search, if its desc it will revert to search for a lower startingAfter

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Create AmazonPay account

Create a new AmazonPay account with the data provided.

Authorizations:
sessionToken
Request Body schema: application/json
chargePermissionId
required
string <= 50 characters

the amazon pay charge permission id

preferred
boolean

flag indicating if amazon pay account is the preferred amazon pay account - only one amazon pay account can be preferred.

invalid
boolean

flag indicating if payment method should be handled as invalid

Responses

Request samples

Content type
application/json
{
  • "chargePermissionId": "S02-7331650-8246451",
  • "preferred": true
}

Response samples

Content type
application/json
{
  • "amazonPayAccountId": 100001,
  • "changedDate": "2019-03-21T17:32:12Z",
  • "customerId": "100003",
  • "chargePermissionId": "S02-7331650-8246451",
  • "active": true,
  • "preferred": true
}

Get AmazonPay account

Get AmazonPay account that is identified by the passed bank account id.

Authorizations:
sessionToken
path Parameters
amazonPayAccountId
required
integer <int64>

unique id of the AmazonPay account

Responses

Response samples

Content type
application/json
{
  • "amazonPayAccountId": 100001,
  • "changedDate": "2019-03-21T17:32:12Z",
  • "customerId": "100003",
  • "chargePermissionId": "S02-7331650-8246451",
  • "active": true,
  • "preferred": true
}

Update AmazonPay account

Update an AmazonPay account that is identified by the passed bank account id with the data provided.

Authorizations:
sessionToken
path Parameters
amazonPayAccountId
required
integer <int64>

unique id of the AmazonPay account

Request Body schema: application/json
chargePermissionId
required
string <= 50 characters

the amazon pay charge permission id

preferred
boolean

flag indicating if amazon pay account is the preferred amazon pay account - only one amazon pay account can be preferred.

invalid
boolean

flag indicating if payment method should be handled as invalid

Responses

Request samples

Content type
application/json
{
  • "chargePermissionId": "S02-7331650-8246451",
  • "preferred": true
}

Response samples

Content type
application/json
{
  • "amazonPayAccountId": 100001,
  • "changedDate": "2019-03-21T17:32:12Z",
  • "customerId": "100003",
  • "chargePermissionId": "S02-7331650-8246451",
  • "active": true,
  • "preferred": true
}

Delete AmazonPay account

Delete an AmazonPay account. This is only possible if bank account is not associated with a subscription. Otherwise the subscription association must be removed first.

Authorizations:
sessionToken
path Parameters
amazonPayAccountId
required
integer <int64>

unique id of the AmazonPay account

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Search bank accounts

Search all bank accounts that correspond to the given search conditions.

Authorizations:
sessionToken
query Parameters
size
integer <int32> [ 5 .. 100 ]

amount of elements to return - if no size is provided or the size is not within range it will be automatically set to 5

startTime
string <date-time>

time the entity was changed after or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

endTime
string <date-time>

time the entity was changed before or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

startingAfter
string <= 100 characters

A cursor for use in pagination. startingAfter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include startingAfter=obj_foo in order to fetch the next result set.

endingBefore
string <= 100 characters

A cursor for use in pagination. endingBefore is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include endingBefore=obj_bar in order to fetch the previous page of the list.

sort
string <= 4 characters
Enum: "ASC" "DESC"

The sort of the search, if its desc it will revert to search for a lower startingAfter

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Create bank account

Create a new bank account with the data provided.

Authorizations:
sessionToken
Request Body schema: application/json
customerId
required
string^[0-9]{1,18}$

unique id of the payment mandate - if not sent plenigo will generate a new one together with a mandate date

mandateId
string

unique id of the payment mandate

mandateDate
string or null <date>

date the payment mandate was created with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

pspMandateId
string <= 100 characters

psp mandate id

owner
required
string <= 30 characters

name on bank account

iban
required
string [ 18 .. 32 ] characters
bic
string [ 8 .. 11 ] characters

BIC - only necessary for countries outside the EU

preferred
boolean

flag indicating if bank account is the preferred bank account - only one bank account can be preferred.

invalid
boolean

flag indicating if payment method should be handled as invalid

Responses

Request samples

Content type
application/json
{
  • "customerId": "100003",
  • "owner": "John Doe",
  • "iban": "GB19123412341234123412",
  • "mandateId": "12342342",
  • "mandateDate": "2019-03-21T17:32:12Z",
  • "preferred": true
}

Response samples

Content type
application/json
{
  • "bankAccountId": 100001,
  • "createdDate": "2019-01-01T07:53:23.450961Z",
  • "createdBy": "PLENIGO",
  • "createdByType": "SYSTEM",
  • "changedDate": "2019-01-01T07:53:23.450961Z",
  • "changedBy": "PLENIGO",
  • "changedByType": "SYSTEM",
  • "customerId": "100003",
  • "owner": "John Doe",
  • "iban": "GB19123412341234123412",
  • "mandateId": "12342342",
  • "mandateDate": "2019-03-21T17:32:12Z",
  • "active": true,
  • "preferred": true
}

Creates a PayOne SEPA mandate

Creates a new PayOne SEPA mandate.

Authorizations:
sessionToken
Request Body schema: application/json
owner
required
string <= 30 characters

name on bank account

iban
required
string [ 18 .. 32 ] characters
bic
string [ 8 .. 11 ] characters

BIC - only necessary for countries outside the EU

preferred
boolean

flag indicating if bank account is the preferred bank account - only one bank account can be preferred.

invalid
boolean

flag indicating if payment method should be handled as invalid

Responses

Request samples

Content type
application/json
{
  • "owner": "John Doe",
  • "iban": "GB19123412341234123412"
}

Response samples

Content type
application/json
{
  • "mandateId": "PO_33423412432",
  • "mandateText": "<b>Mandate-ID</b>",
  • "mandateStatus": "open"
}

Get bank account

Get bank account that is identified by the passed bank account id.

Authorizations:
sessionToken
path Parameters
bankAccountId
required
integer <int64>

unique id of the bank account

Responses

Response samples

Content type
application/json
{
  • "bankAccountId": 100001,
  • "createdDate": "2019-01-01T07:53:23.450961Z",
  • "createdBy": "PLENIGO",
  • "createdByType": "SYSTEM",
  • "changedDate": "2019-01-01T07:53:23.450961Z",
  • "changedBy": "PLENIGO",
  • "changedByType": "SYSTEM",
  • "customerId": "100003",
  • "owner": "John Doe",
  • "iban": "GB19123412341234123412",
  • "mandateId": "12342342",
  • "mandateDate": "2019-03-21T17:32:12Z",
  • "active": true,
  • "preferred": true
}

Update bank account

Update a bank account that is identified by the passed bank account id with the data provided.

Authorizations:
sessionToken
path Parameters
bankAccountId
required
integer <int64>

unique id of the bank account

Request Body schema: application/json
owner
required
string <= 30 characters

name on bank account

iban
required
string [ 18 .. 32 ] characters
bic
string [ 8 .. 11 ] characters

BIC - only necessary for countries outside the EU

preferred
boolean

flag indicating if bank account is the preferred bank account - only one bank account can be preferred.

invalid
boolean

flag indicating if payment method should be handled as invalid

Responses

Request samples

Content type
application/json
{
  • "owner": "John Doe",
  • "iban": "GB19123412341234123412"
}

Response samples

Content type
application/json
{
  • "bankAccountId": 100001,
  • "createdDate": "2019-01-01T07:53:23.450961Z",
  • "createdBy": "PLENIGO",
  • "createdByType": "SYSTEM",
  • "changedDate": "2019-01-01T07:53:23.450961Z",
  • "changedBy": "PLENIGO",
  • "changedByType": "SYSTEM",
  • "customerId": "100003",
  • "owner": "John Doe",
  • "iban": "GB19123412341234123412",
  • "mandateId": "12342342",
  • "mandateDate": "2019-03-21T17:32:12Z",
  • "active": true,
  • "preferred": true
}

Delete bank account

Delete a bank account. This is only possible if bank account is not associated with a subscription. Otherwise the subscription association must be removed first.

Authorizations:
sessionToken
path Parameters
bankAccountId
required
integer <int64>

unique id of the bank account

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Search credit cards

Search all credit cards that correspond to the given search conditions.

Authorizations:
sessionToken
query Parameters
size
integer <int32> [ 5 .. 100 ]

amount of elements to return - if no size is provided or the size is not within range it will be automatically set to 5

startTime
string <date-time>

time the entity was changed after or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

endTime
string <date-time>

time the entity was changed before or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

startingAfter
string <= 100 characters

A cursor for use in pagination. startingAfter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include startingAfter=obj_foo in order to fetch the next result set.

endingBefore
string <= 100 characters

A cursor for use in pagination. endingBefore is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include endingBefore=obj_bar in order to fetch the previous page of the list.

sort
string <= 4 characters
Enum: "ASC" "DESC"

The sort of the search, if its desc it will revert to search for a lower startingAfter

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Create credit card

Create a new credit card with the data provided.

Authorizations:
sessionToken
Request Body schema: application/json
owner
required
string <= 30 characters

name on credit card

cardType
string
Enum: "VISA" "MASTERCARD" "AMERICAN_EXPRESS" "DISCOVER" "DINERS_CLUB" "JCB"

type of the credit card provided

providerToken
required
string <= 100 characters

unique credit card token provided by the payment service provider to identify credit card

obfuscatedNumber
required
string <= 30 characters

obfuscated credit card number

validTo
required
string or null <date>

date the credit card is valid to with full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-01 - must be in the future

preferred
boolean

flag indicating if credit card is the preferred credit card - only one credit card can be preferred.

invalid
boolean

flag indicating if payment method should be handled as invalid

Responses

Request samples

Content type
application/json
{
  • "owner": "John Doe",
  • "cardType": "MASTERCARD",
  • "providerToken": "C13487324913",
  • "obfuscatedNumber": "132412432xxxxx1234",
  • "validTo": "2019-07-01",
  • "preferred": true
}

Response samples

Content type
application/json
{
  • "creditCardId": 100001,
  • "createdDate": "2019-01-01T07:53:23.450961Z",
  • "createdBy": "PLENIGO",
  • "createdByType": "SYSTEM",
  • "changedDate": "2019-01-01T07:53:23.450961Z",
  • "changedBy": "PLENIGO",
  • "changedByType": "SYSTEM",
  • "customerId": "100003",
  • "owner": "John Doe",
  • "cardType": "MASTERCARD",
  • "paymentProvider": "STRIPE",
  • "providerToken": "C13487324913",
  • "obfuscatedNumber": "132412432xxxxx1234",
  • "validTo": "2019-07-01",
  • "active": true,
  • "preferred": true
}

Get credit card

Get credit card that is identified by the passed credit card id.

Authorizations:
sessionToken
path Parameters
creditCardId
required
integer <int64>

unique id of the credit card

Responses

Response samples

Content type
application/json
{
  • "creditCardId": 100001,
  • "createdDate": "2019-01-01T07:53:23.450961Z",
  • "createdBy": "PLENIGO",
  • "createdByType": "SYSTEM",
  • "changedDate": "2019-01-01T07:53:23.450961Z",
  • "changedBy": "PLENIGO",
  • "changedByType": "SYSTEM",
  • "customerId": "100003",
  • "owner": "John Doe",
  • "cardType": "MASTERCARD",
  • "paymentProvider": "STRIPE",
  • "providerToken": "C13487324913",
  • "obfuscatedNumber": "132412432xxxxx1234",
  • "validTo": "2019-07-01",
  • "active": true,
  • "preferred": true
}

Update credit card

Update a bank account that is identified by the passed address id with the data provided.

Authorizations:
sessionToken
path Parameters
creditCardId
required
integer <int64>

unique id of the credit card

Request Body schema: application/json
owner
required
string <= 30 characters

name on credit card

cardType
string
Enum: "VISA" "MASTERCARD" "AMERICAN_EXPRESS" "DISCOVER" "DINERS_CLUB" "JCB"

type of the credit card provided

providerToken
required
string <= 100 characters

unique credit card token provided by the payment service provider to identify credit card

obfuscatedNumber
required
string <= 30 characters

obfuscated credit card number

validTo
required
string or null <date>

date the credit card is valid to with full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-01 - must be in the future

preferred
boolean

flag indicating if credit card is the preferred credit card - only one credit card can be preferred.

invalid
boolean

flag indicating if payment method should be handled as invalid

Responses

Request samples

Content type
application/json
{
  • "owner": "John Doe",
  • "cardType": "MASTERCARD",
  • "providerToken": "C13487324913",
  • "obfuscatedNumber": "132412432xxxxx1234",
  • "validTo": "2019-07-01",
  • "preferred": true
}

Response samples

Content type
application/json
{
  • "creditCardId": 100001,
  • "createdDate": "2019-01-01T07:53:23.450961Z",
  • "createdBy": "PLENIGO",
  • "createdByType": "SYSTEM",
  • "changedDate": "2019-01-01T07:53:23.450961Z",
  • "changedBy": "PLENIGO",
  • "changedByType": "SYSTEM",
  • "customerId": "100003",
  • "owner": "John Doe",
  • "cardType": "MASTERCARD",
  • "paymentProvider": "STRIPE",
  • "providerToken": "C13487324913",
  • "obfuscatedNumber": "132412432xxxxx1234",
  • "validTo": "2019-07-01",
  • "active": true,
  • "preferred": true
}

Delete credit card

Delete a credit card. This is only possible if credit card is not associated with a subscription. Otherwise the subscription association must be removed first.

Authorizations:
sessionToken
path Parameters
creditCardId
required
integer <int64>

unique id of the credit card

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Search iDeal accounts

Search all iDeal accounts that correspond to the given search conditions.

Authorizations:
sessionToken
query Parameters
size
integer <int32> [ 5 .. 100 ]

amount of elements to return - if no size is provided or the size is not within range it will be automatically set to 5

startTime
string <date-time>

time the entity was changed after or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

endTime
string <date-time>

time the entity was changed before or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

startingAfter
string <= 100 characters

A cursor for use in pagination. startingAfter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include startingAfter=obj_foo in order to fetch the next result set.

endingBefore
string <= 100 characters

A cursor for use in pagination. endingBefore is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include endingBefore=obj_bar in order to fetch the previous page of the list.

sort
string <= 4 characters
Enum: "ASC" "DESC"

The sort of the search, if its desc it will revert to search for a lower startingAfter

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Create iDeal account

Create a new iDeal account with the data provided.

Authorizations:
sessionToken
Request Body schema: application/json
owner
required
string <= 30 characters

name on bank account

obfuscatedIban
required
string <= 32 characters

obfuscated IBAN

pspAccountId
required
string <= 100 characters

payment service provider iDeal account id

fingerprint
required
string <= 100 characters

fingerprint to check account uniqueness

preferred
required
boolean

flag indicating if iDeal account is the preferred one

invalid
boolean

flag indicating if payment method should be handled as invalid

Responses

Request samples

Content type
application/json
{
  • "owner": "John Doe",
  • "obfuscatedIban": "GB19123412341234123412",
  • "pspAccountId": "pk_TYooMQauvdEDq54NiTphI7jx",
  • "fingerprint": "Xt5EWLLDS7FJjR1c"
}

Response samples

Content type
application/json
{
  • "iDealAccountId": 100001,
  • "changedDate": "2019-03-21T17:32:12Z",
  • "customerId": "100003",
  • "owner": "John Doe",
  • "obfuscatedIban": "GB19123412341234123412",
  • "pspAccountId": "pk_TYooMQauvdEDq54NiTphI7jx",
  • "fingerprint": "Xt5EWLLDS7FJjR1c",
  • "active": true
}

Get iDeal account

Get iDeal account that is identified by the passed iDeal account id.

Authorizations:
sessionToken
path Parameters
iDealAccountId
required
integer <int64>

unique id of the iDeal account

Responses

Response samples

Content type
application/json
{
  • "iDealAccountId": 100001,
  • "changedDate": "2019-03-21T17:32:12Z",
  • "customerId": "100003",
  • "owner": "John Doe",
  • "obfuscatedIban": "GB19123412341234123412",
  • "pspAccountId": "pk_TYooMQauvdEDq54NiTphI7jx",
  • "fingerprint": "Xt5EWLLDS7FJjR1c",
  • "active": true
}

Update iDeal account

Update an iDeal account that is identified by the passed iDeal account id with the data provided.

Authorizations:
sessionToken
path Parameters
iDealAccountId
required
integer <int64>

unique id of the iDeal account

Request Body schema: application/json
owner
required
string <= 30 characters

name on bank account

obfuscatedIban
required
string <= 32 characters

obfuscated IBAN

pspAccountId
required
string <= 100 characters

payment service provider iDeal account id

fingerprint
required
string <= 100 characters

fingerprint to check account uniqueness

preferred
required
boolean

flag indicating if iDeal account is the preferred one

invalid
boolean

flag indicating if payment method should be handled as invalid

Responses

Request samples

Content type
application/json
{
  • "owner": "John Doe",
  • "obfuscatedIban": "GB19123412341234123412",
  • "pspAccountId": "pk_TYooMQauvdEDq54NiTphI7jx",
  • "fingerprint": "Xt5EWLLDS7FJjR1c"
}

Response samples

Content type
application/json
{
  • "iDealAccountId": 100001,
  • "changedDate": "2019-03-21T17:32:12Z",
  • "customerId": "100003",
  • "owner": "John Doe",
  • "obfuscatedIban": "GB19123412341234123412",
  • "pspAccountId": "pk_TYooMQauvdEDq54NiTphI7jx",
  • "fingerprint": "Xt5EWLLDS7FJjR1c",
  • "active": true
}

Delete iDeal account

Delete an iDeal account. This is only possible if iDeal account is not associated with a subscription. Otherwise the subscription association must be removed first.

Authorizations:
sessionToken
path Parameters
iDealAccountId
required
integer <int64>

unique id of the iDeal account

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Search PayPal accounts

Search all PayPal accounts accounts that correspond to the given search conditions.

Authorizations:
sessionToken
query Parameters
size
integer <int32> [ 5 .. 100 ]

amount of elements to return - if no size is provided or the size is not within range it will be automatically set to 5

startTime
string <date-time>

time the entity was changed after or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

endTime
string <date-time>

time the entity was changed before or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

startingAfter
string <= 100 characters

A cursor for use in pagination. startingAfter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include startingAfter=obj_foo in order to fetch the next result set.

endingBefore
string <= 100 characters

A cursor for use in pagination. endingBefore is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include endingBefore=obj_bar in order to fetch the previous page of the list.

sort
string <= 4 characters
Enum: "ASC" "DESC"

The sort of the search, if its desc it will revert to search for a lower startingAfter

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Create PayPal account

Create a new PayPal account with the data provided.

Authorizations:
sessionToken
Request Body schema: application/json
billingAgreementId
required
string <= 30 characters

PayPal billing agreement

preferred
boolean

flag indicating if PayPal account is the preferred PayPal account - only one PayPal account can be preferred.

invalid
boolean

flag indicating if payment method should be handled as invalid

Responses

Request samples

Content type
application/json
{
  • "billingAgreementId": "B-1234124324124",
  • "preferred": true
}

Response samples

Content type
application/json
{
  • "billingAgreementId": "B-1234124324124",
  • "changedDate": "2019-03-21T17:32:12Z",
  • "active": true,
  • "preferred": true
}

Get PayPal account

Get PayPal account that is identified by the passed bank account id.

Authorizations:
sessionToken
path Parameters
payPalAccountId
required
integer <int64>

unique id of the PayPal account

Responses

Response samples

Content type
application/json
{
  • "billingAgreementId": "B-1234124324124",
  • "changedDate": "2019-03-21T17:32:12Z",
  • "active": true,
  • "preferred": true
}

Update PayPal account

Update a PayPal account that is identified by the passed bank account id with the data provided.

Authorizations:
sessionToken
path Parameters
payPalAccountId
required
integer <int64>

unique id of the PayPal account

Request Body schema: application/json
billingAgreementId
required
string <= 30 characters

PayPal billing agreement

preferred
boolean

flag indicating if PayPal account is the preferred PayPal account - only one PayPal account can be preferred.

invalid
boolean

flag indicating if payment method should be handled as invalid

Responses

Request samples

Content type
application/json
{
  • "billingAgreementId": "B-1234124324124",
  • "preferred": true
}

Response samples

Content type
application/json
{
  • "billingAgreementId": "B-1234124324124",
  • "changedDate": "2019-03-21T17:32:12Z",
  • "active": true,
  • "preferred": true
}

Delete PayPal account

Delete a PayPal account. This is only possible if bank account is not associated with a subscription. Otherwise the subscription association must be removed first.

Authorizations:
sessionToken
path Parameters
payPalAccountId
required
integer <int64>

unique id of the PayPal account

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Search PostFinance accounts

Search all PostFinance accounts accounts that correspond to the given search conditions.

Authorizations:
sessionToken
query Parameters
size
integer <int32> [ 5 .. 100 ]

amount of elements to return - if no size is provided or the size is not within range it will be automatically set to 5

startTime
string <date-time>

time the entity was changed after or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

endTime
string <date-time>

time the entity was changed before or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

startingAfter
string <= 100 characters

A cursor for use in pagination. startingAfter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include startingAfter=obj_foo in order to fetch the next result set.

endingBefore
string <= 100 characters

A cursor for use in pagination. endingBefore is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include endingBefore=obj_bar in order to fetch the previous page of the list.

sort
string <= 4 characters
Enum: "ASC" "DESC"

The sort of the search, if its desc it will revert to search for a lower startingAfter

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Create PostFinance account

Create a new PostFinance account with the data provided.

Authorizations:
sessionToken
Request Body schema: application/json
chargePermissionId
required
string <= 50 characters

the PostFinance charge permission id

preferred
boolean

flag indicating if PostFinance account is the preferred PostFinance account - only one PostFinance account can be preferred.

invalid
boolean

flag indicating if payment method should be handled as invalid

Responses

Request samples

Content type
application/json
{
  • "chargePermissionId": "S02-7331650-8246451",
  • "preferred": true
}

Response samples

Content type
application/json
{
  • "postFinanceAccountId": 100001,
  • "changedDate": "2019-03-21T17:32:12Z",
  • "customerId": "100003",
  • "chargePermissionId": "S02-7331650-8246451",
  • "active": true,
  • "preferred": true
}

Get PostFinance account

Get PostFinance account that is identified by the passed bank account id.

Authorizations:
sessionToken
path Parameters
postFinanceAccountId
required
integer <int64>

unique id of the PostFinance account

Responses

Response samples

Content type
application/json
{
  • "postFinanceAccountId": 100001,
  • "changedDate": "2019-03-21T17:32:12Z",
  • "customerId": "100003",
  • "chargePermissionId": "S02-7331650-8246451",
  • "active": true,
  • "preferred": true
}

Update PostFinance account

Update a PostFinance account that is identified by the passed bank account id with the data provided.

Authorizations:
sessionToken
path Parameters
postFinanceAccountId
required
integer <int64>

unique id of the PostFinance account

Request Body schema: application/json
chargePermissionId
required
string <= 50 characters

the PostFinance charge permission id

preferred
boolean

flag indicating if PostFinance account is the preferred PostFinance account - only one PostFinance account can be preferred.

invalid
boolean

flag indicating if payment method should be handled as invalid

Responses

Request samples

Content type
application/json
{
  • "chargePermissionId": "S02-7331650-8246451",
  • "preferred": true
}

Response samples

Content type
application/json
{
  • "postFinanceAccountId": 100001,
  • "changedDate": "2019-03-21T17:32:12Z",
  • "customerId": "100003",
  • "chargePermissionId": "S02-7331650-8246451",
  • "active": true,
  • "preferred": true
}

Delete PostFinance account

Delete a PostFinance account. This is only possible if bank account is not associated with a subscription. Otherwise the subscription association must be removed first.

Authorizations:
sessionToken
path Parameters
postFinanceAccountId
required
integer <int64>

unique id of the PostFinance account

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Search Twint accounts

Search all Twint accounts accounts that correspond to the given search conditions.

Authorizations:
sessionToken
query Parameters
size
integer <int32> [ 5 .. 100 ]

amount of elements to return - if no size is provided or the size is not within range it will be automatically set to 5

startTime
string <date-time>

time the entity was changed after or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

endTime
string <date-time>

time the entity was changed before or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

startingAfter
string <= 100 characters

A cursor for use in pagination. startingAfter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include startingAfter=obj_foo in order to fetch the next result set.

endingBefore
string <= 100 characters

A cursor for use in pagination. endingBefore is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include endingBefore=obj_bar in order to fetch the previous page of the list.

sort
string <= 4 characters
Enum: "ASC" "DESC"

The sort of the search, if its desc it will revert to search for a lower startingAfter

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Create Twint account

Create a new Twint account with the data provided.

Authorizations:
sessionToken
Request Body schema: application/json
chargePermissionId
required
string <= 50 characters

the Twint charge permission id

preferred
boolean

flag indicating if Twint account is the preferred Twint account - only one Twint account can be preferred.

invalid
boolean

flag indicating if payment method should be handled as invalid

Responses

Request samples

Content type
application/json
{
  • "chargePermissionId": "S02-7331650-8246451",
  • "preferred": true
}

Response samples

Content type
application/json
{
  • "twintAccountId": 100001,
  • "changedDate": "2019-03-21T17:32:12Z",
  • "customerId": "100003",
  • "chargePermissionId": "S02-7331650-8246451",
  • "active": true,
  • "preferred": true
}

Get Twint account

Get Twint account that is identified by the passed bank account id.

Authorizations:
sessionToken
path Parameters
twintAccountId
required
integer <int64>

unique id of the Twint account

Responses

Response samples

Content type
application/json
{
  • "twintAccountId": 100001,
  • "changedDate": "2019-03-21T17:32:12Z",
  • "customerId": "100003",
  • "chargePermissionId": "S02-7331650-8246451",
  • "active": true,
  • "preferred": true
}

Update Twint account

Update a Twint account that is identified by the passed bank account id with the data provided.

Authorizations:
sessionToken
path Parameters
twintAccountId
required
integer <int64>

unique id of the Twint account

Request Body schema: application/json
chargePermissionId
required
string <= 50 characters

the Twint charge permission id

preferred
boolean

flag indicating if Twint account is the preferred Twint account - only one Twint account can be preferred.

invalid
boolean

flag indicating if payment method should be handled as invalid

Responses

Request samples

Content type
application/json
{
  • "chargePermissionId": "S02-7331650-8246451",
  • "preferred": true
}

Response samples

Content type
application/json
{
  • "twintAccountId": 100001,
  • "changedDate": "2019-03-21T17:32:12Z",
  • "customerId": "100003",
  • "chargePermissionId": "S02-7331650-8246451",
  • "active": true,
  • "preferred": true
}

Delete Twint account

Delete a Twint account. This is only possible if bank account is not associated with a subscription. Otherwise the subscription association must be removed first.

Authorizations:
sessionToken
path Parameters
twintAccountId
required
integer <int64>

unique id of the Twint account

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Initialize credit card - PayOne

Initialize a PayOne credit card form.

Authorizations:
sessionToken

Responses

Response samples

Content type
application/json
{
  • "mode": "live",
  • "subAccountId": "93273",
  • "merchantId": "13732",
  • "portalId": "289373",
  • "hash": "2fcab58712467eab"
}

Pre authorize credit card - PayOne

Pre authorize credit card through PayOne.

Authorizations:
sessionToken
Request Body schema: application/json
owner
required
string <= 50 characters

Owner of the credit card

pseudoCardPan
required
string <= 30 characters

Pseudo card pan provided by PayOne form result

successUrl
required
string <uri> <= 255 characters

success url to redirect to after 3D secure check was successful

errorUrl
required
string <uri> <= 255 characters

error url to redirect to after 3D secure check failed

backUrl
required
string <uri> <= 255 characters

back url to redirect to if customer aborts the process

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
Example
{
  • "status": "SUCCESS"
}

Initialize Stripe credit card authorization

Initialize Stripe credit card process.

Authorizations:
sessionToken

Responses

Response samples

Content type
application/json
{
  • "clientSecret": "X43247ANMEDI2732ADME",
  • "publicKey": "MXXASEDMMENMEDI2732ADME"
}

Retrieve Stripe credit card data

Retrieve Stripe credit card details for temporary token.

Authorizations:
sessionToken
Request Body schema: application/json
owner
string

Credit card owner

creditCardId
string

Stripe credit card id

Responses

Request samples

Content type
application/json
{
  • "owner": "John Doe",
  • "creditCardId": "14234792430143"
}

Response samples

Content type
application/json
{
  • "owner": "John Doe",
  • "cardType": "VISA",
  • "providerToken": "cc_34242342423234",
  • "obfuscatedNumber": "XXXXXXXXXXXXXXX4232",
  • "validTo": "12/2020"
}

Initialize Stripe iDeal authorization

Initialize Stripe iDeal process.

Authorizations:
sessionToken

Responses

Response samples

Content type
application/json
{
  • "clientSecret": "X43247ANMEDI2732ADME",
  • "publicKey": "MXXASEDMMENMEDI2732ADME",
  • "setupIntentId": "pk_TYooMQauvdEDq54NiTphI7jx"
}

Retrieve Stripe iDeal data

Retrieve Stripe iDeal details for temporary token.

Authorizations:
sessionToken
Request Body schema: application/json
setupIntentId
string

Setup intent id

Responses

Request samples

Content type
application/json
{
  • "setupIntentId": "pk_TYooMQauvdEDq54NiTphI7jx"
}

Response samples

Content type
application/json
{
  • "obfuscatedIban": "GBXXXXXXXXXXXXXXX3412",
  • "pspAccountId": "pk_TYooMQauvdEDq54NiTphI7jx",
  • "fingerprint": "Xt5EWLLDS7FJjR1c"
}

Initialize PayPal billing agreement

Initialize PayPal billing agreement and start billing agreement process.

Authorizations:
sessionToken
Request Body schema: application/json
successUrl
string <uri> <= 255 characters

success url to redirect customer to after billing agreement was accepted

cancellationUrl
string <uri> <= 255 characters

url to redirect customer to if the billing agreement process is cancelled

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Create PayPal billing agreement

Create PayPal billing agreement.

Authorizations:
sessionToken
Request Body schema: application/json
tokenId
string <= 40 characters

billing agreement id

Responses

Request samples

Content type
application/json
{
  • "tokenId": "B-13434134123424"
}

Response samples

Content type
application/json
{
  • "id": "52341234123"
}

Profile

Add two factor

Add two factor authenticator to the current session user.

Authorizations:
sessionToken
Request Body schema: application/json
token
string <= 100 characters

The jwt token to validate the step.

twoFactorToken
string = 6 characters

The two factor token.

Responses

Request samples

Content type
application/json
{
  • "token": "enk328952342knl234DAD",
  • "twoFactorToken": 123456
}

Response samples

Content type
application/json
{
  • "success": true
}

Get user data

Get complete data of a session user.

Authorizations:
sessionToken

Responses

Response samples

Content type
application/json
{
  • "customerId": "100003",
  • "username": "wild_flower",
  • "email": "wildflower@example.com",
  • "invoiceEmail": "wildflower-invoices@example.com",
  • "birthday": "2001-03-21",
  • "language": "de",
  • "mobileNumber": "+14155552671",
  • "status": "ACTIVATED",
  • "acceptedTerms": {
    }
}

Change age verification pin

Change age verification pin.

Authorizations:
sessionToken
Request Body schema: application/json
password
string <= 8 characters

age pin

Responses

Request samples

Content type
application/json
{
  • "pin": "1234"
}

Response samples

Content type
application/json
{
  • "customerId": "100003",
  • "username": "wild_flower",
  • "email": "wildflower@example.com",
  • "invoiceEmail": "wildflower-invoices@example.com",
  • "birthday": "2001-03-21",
  • "language": "de",
  • "mobileNumber": "+14155552671",
  • "status": "ACTIVATED",
  • "acceptedTerms": {
    }
}

Change user data

Change first name and last name of the session user.

Authorizations:
sessionToken
Request Body schema: application/json
salutation
string
Enum: "DIVERSE" "MR" "MRS" "NONE"

salutation to identify the correct designation of a customer

firstName
string <= 100 characters

first name of the customer - first name and last name or company name are required

lastName
string <= 100 characters

last name of the customer - first name and last name or company name are required

Responses

Request samples

Content type
application/json
{
  • "firstName": "John",
  • "lastName": "Doe"
}

Response samples

Content type
application/json
{
  • "customerId": "100003",
  • "username": "wild_flower",
  • "email": "wildflower@example.com",
  • "invoiceEmail": "wildflower-invoices@example.com",
  • "birthday": "2001-03-21",
  • "language": "de",
  • "mobileNumber": "+14155552671",
  • "status": "ACTIVATED",
  • "acceptedTerms": {
    }
}

Change password

Change password of the session user.

Authorizations:
sessionToken
Request Body schema: application/json
password
required
string <= 100 characters

current password of the customer

newPassword
required
string <= 100 characters

new password of the customer

Responses

Request samples

Content type
application/json
{
  • "password": "oldPassword",
  • "newPassword": "newPassword"
}

Response samples

Content type
application/json
{
  • "customerId": "100003",
  • "username": "wild_flower",
  • "email": "wildflower@example.com",
  • "invoiceEmail": "wildflower-invoices@example.com",
  • "birthday": "2001-03-21",
  • "language": "de",
  • "mobileNumber": "+14155552671",
  • "status": "ACTIVATED",
  • "acceptedTerms": {
    }
}

Change email

Start change email process of the session user.

Authorizations:
sessionToken
Request Body schema: application/json
email
string <email> <= 100 characters

new email of the customer

Responses

Request samples

Content type
application/json
{
  • "email": "test@example.com"
}

Response samples

Content type
application/json
{
  • "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
}

Change username

Change username of the session user.

Authorizations:
sessionToken
Request Body schema: application/json
username
string <= 100 characters

new username of the customer

Responses

Request samples

Content type
application/json
{
  • "username": "user1"
}

Response samples

Content type
application/json
{
  • "success": true
}

Initialize two factor

Initialize process for adding a two factor authenticator for the current session user.

Authorizations:
sessionToken

Responses

Response samples

Content type
application/json
{
  • "companyId": "string",
  • "nextStep": "ADDITIONAL_DATA",
  • "twoFactorBarCodeImage": "string",
  • "verificationToken": "string",
  • "additionalInformation": { },
  • "token": "string"
}

Logout

Deletes current active user session

Authorizations:
sessionToken

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Remove two factor

Remove two factor authenticator from the current session user.

Authorizations:
sessionToken

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Resend email

Resend email with verification token.

Authorizations:
sessionToken
Request Body schema: application/json
token
required
string

The token to validate the step.

Responses

Request samples

Content type
application/json
{
  • "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
}

Response samples

Content type
application/json
{
  • "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
}

Verify age verification pin

Verify age verification pin.

Authorizations:
sessionToken
Request Body schema: application/json
password
string <= 8 characters

age pin

Responses

Request samples

Content type
application/json
{
  • "pin": "1234"
}

Response samples

Content type
application/json
{
  • "success": true
}

Verify current password

Verifies the current password.

Authorizations:
sessionToken
Request Body schema: application/json
password
string <= 100 characters

password to check

Responses

Request samples

Content type
application/json
{
  • "password": "BestPassword"
}

Response samples

Content type
application/json
{
  • "success": true
}

Verify email token

Verify new email address by email verification token.

Authorizations:
sessionToken
Request Body schema: application/json
token
string <= 100 characters

The jwt token to validate the step.

verificationToken
string = 6 characters

The verification token.

Responses

Request samples

Content type
application/json
{
  • "token": "enk328952342knl234DAD",
  • "verificationToken": 123456
}

Response samples

Content type
application/json
{
  • "success": true
}

Sessions

Get active sessions

Get all active customer sessions.

Authorizations:
sessionToken

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Delete customer session

Deletes a customer session.

Authorizations:
sessionToken
query Parameters
sessionId
required
string <= 40 characters

id of the session

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Validate Transfer Token

Validates a transfer token and returns the session information in case of a transfer token.

Authorizations:
sessionToken
path Parameters
companyId
required
string

unique id of a company

query Parameters
transferToken
required
string <= 50 characters

transfer token

Responses

Response samples

Content type
application/json
{
  • "customerSession": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
}

Settings

Get snippet settings

Get settings needed for snippets.

Authorizations:
sessionToken
query Parameters
language
string = 2 characters

language of the request - two letter language code according to ISO 639-1

Responses

Response samples

Content type
application/json
{
  • "paymentProvider": "STRIPE",
  • "designs": {
    }
}

Get translation for text module

Returns translation for text module.

Authorizations:
sessionToken
path Parameters
plenigoOfferId
required
string

plenigo offer id

language
required
string = 2 characters

language to use - two letter language code according to ISO 639-1

Responses

Response samples

Content type
application/json
{
  • "language": "st",
  • "text": "string",
  • "preferred": true
}

Subscriptions

Search subscriptions

Search all subscriptions that correspond to the given search conditions.

Authorizations:
sessionToken
query Parameters
size
integer <int32> [ 5 .. 100 ]

amount of elements to return - if no size is provided or the size is not within range it will be automatically set to 5

startTime
string <date-time>

time the entity was changed after or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

endTime
string <date-time>

time the entity was changed before or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

startingAfter
string <= 100 characters

A cursor for use in pagination. startingAfter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include startingAfter=obj_foo in order to fetch the next result set.

endingBefore
string <= 100 characters

A cursor for use in pagination. endingBefore is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include endingBefore=obj_bar in order to fetch the previous page of the list.

sort
string <= 4 characters
Enum: "ASC" "DESC"

The sort of the search, if its desc it will revert to search for a lower startingAfter

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Search cross client

Search all cross client subscriptions that correspond to the given search conditions.

Authorizations:
sessionToken
query Parameters
size
integer <int32> [ 5 .. 100 ]

amount of elements to return - if no size is provided or the size is not within range it will be automatically set to 5

startTime
string <date-time>

time the entity was changed after or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

endTime
string <date-time>

time the entity was changed before or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

startingAfter
string <= 100 characters

A cursor for use in pagination. startingAfter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include startingAfter=obj_foo in order to fetch the next result set.

endingBefore
string <= 100 characters

A cursor for use in pagination. endingBefore is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include endingBefore=obj_bar in order to fetch the previous page of the list.

sort
string <= 4 characters
Enum: "ASC" "DESC"

The sort of the search, if its desc it will revert to search for a lower startingAfter

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get subscription

Get subscription that is identified by the passed subscription id.

Authorizations:
sessionToken
path Parameters
subscriptionId
required
integer <int64>

unique id of the subscription

Responses

Response samples

Content type
application/json
{
  • "subscriptionId": 9310,
  • "changedDate": "2019-03-21T17:32:12Z",
  • "startDate": "2019-02-01T17:32:12Z",
  • "endDate": "2090-02-01TT17:32:12Z",
  • "chainId": 9310,
  • "plenigoOfferId": "O_MZA1E7173120881551",
  • "invoiceCustomerId": "100003",
  • "deliveryCustomerId": "100003",
  • "term": 12,
  • "termTimeSpan": "MONTH",
  • "accountingPeriod": 1,
  • "accountingPeriodTimeSpan": "MONTH",
  • "cancellationPeriod": 1,
  • "cancellationPeriodTimeSpan": "DAY",
  • "currency": "EUR",
  • "paymentMethod": "CREDIT_CARD",
  • "paymentMethodId": 100230,
  • "accessBlocked": false,
  • "firstBookingDate": "2019-02-01",
  • "lastBookingDate": "2019-08-01",
  • "nextBookingDate": "2019-09-01",
  • "status": "ACTIVE",
  • "items": [
    ]
}

Change address

Change the address that is associated with a subscription.

Authorizations:
sessionToken
path Parameters
subscriptionId
required
integer <int64>

unique id of the subscription

Request Body schema: application/json
addressId
required
integer <int64>

id of the address to add to the subscription

addressType
required
string
Enum: "INVOICE" "DELIVERY"

address type of the address to change

Responses

Request samples

Content type
application/json
{
  • "addressId": 28023,
  • "addressType": "INVOICE"
}

Response samples

Content type
application/json
{
  • "subscriptionId": 9310,
  • "changedDate": "2019-03-21T17:32:12Z",
  • "startDate": "2019-02-01T17:32:12Z",
  • "endDate": "2090-02-01TT17:32:12Z",
  • "chainId": 9310,
  • "plenigoOfferId": "O_MZA1E7173120881551",
  • "invoiceCustomerId": "100003",
  • "deliveryCustomerId": "100003",
  • "term": 12,
  • "termTimeSpan": "MONTH",
  • "accountingPeriod": 1,
  • "accountingPeriodTimeSpan": "MONTH",
  • "cancellationPeriod": 1,
  • "cancellationPeriodTimeSpan": "DAY",
  • "currency": "EUR",
  • "paymentMethod": "CREDIT_CARD",
  • "paymentMethodId": 100230,
  • "accessBlocked": false,
  • "firstBookingDate": "2019-02-01",
  • "lastBookingDate": "2019-08-01",
  • "nextBookingDate": "2019-09-01",
  • "status": "ACTIVE",
  • "items": [
    ]
}

Cancel

Cancel a subscription to the next regular end date.

Authorizations:
sessionToken
path Parameters
subscriptionId
required
integer <int64>

unique id of the subscription

query Parameters
cancellationReasonUniqueId
string

unique id of the cancellation reason

Responses

Response samples

Content type
application/json
{
  • "subscriptionId": 9310,
  • "changedDate": "2019-03-21T17:32:12Z",
  • "startDate": "2019-02-01T17:32:12Z",
  • "endDate": "2090-02-01TT17:32:12Z",
  • "chainId": 9310,
  • "plenigoOfferId": "O_MZA1E7173120881551",
  • "invoiceCustomerId": "100003",
  • "deliveryCustomerId": "100003",
  • "term": 12,
  • "termTimeSpan": "MONTH",
  • "accountingPeriod": 1,
  • "accountingPeriodTimeSpan": "MONTH",
  • "cancellationPeriod": 1,
  • "cancellationPeriodTimeSpan": "DAY",
  • "currency": "EUR",
  • "paymentMethod": "CREDIT_CARD",
  • "paymentMethodId": 100230,
  • "accessBlocked": false,
  • "firstBookingDate": "2019-02-01",
  • "lastBookingDate": "2019-08-01",
  • "nextBookingDate": "2019-09-01",
  • "status": "ACTIVE",
  • "items": [
    ]
}

Cancel a running subscription at a given date

Cancel a running subscription to a given date.

Authorizations:
sessionToken
path Parameters
subscriptionId
required
integer <int64>

unique id of the subscription

query Parameters
cancellationReasonUniqueId
string

unique id of the cancellation reason

Request Body schema: application/json
cancellationDate
string or null <date>

date subscription should end with full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

Responses

Request samples

Content type
application/json
{
  • "cancellationDate": "2019-02-01"
}

Response samples

Content type
application/json
{
  • "subscriptionId": 9310,
  • "changedDate": "2019-03-21T17:32:12Z",
  • "startDate": "2019-02-01T17:32:12Z",
  • "endDate": "2090-02-01TT17:32:12Z",
  • "chainId": 9310,
  • "plenigoOfferId": "O_MZA1E7173120881551",
  • "invoiceCustomerId": "100003",
  • "deliveryCustomerId": "100003",
  • "term": 12,
  • "termTimeSpan": "MONTH",
  • "accountingPeriod": 1,
  • "accountingPeriodTimeSpan": "MONTH",
  • "cancellationPeriod": 1,
  • "cancellationPeriodTimeSpan": "DAY",
  • "currency": "EUR",
  • "paymentMethod": "CREDIT_CARD",
  • "paymentMethodId": 100230,
  • "accessBlocked": false,
  • "firstBookingDate": "2019-02-01",
  • "lastBookingDate": "2019-08-01",
  • "nextBookingDate": "2019-09-01",
  • "status": "ACTIVE",
  • "items": [
    ]
}

Get possible cancellation dates

Get possible cancellation dates of a running subscription.

Authorizations:
sessionToken
path Parameters
subscriptionId
required
integer <int64>

unique id of the subscription

query Parameters
cancellationReasonUniqueId
string

unique id of the cancellation reason

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Undo cancellation

Undo cancellation of a subscription that is cancelled but has not reached the end of its runtime yet.

Authorizations:
sessionToken
path Parameters
subscriptionId
required
integer <int64>

unique id of the subscription

Responses

Response samples

Content type
application/json
{
  • "subscriptionId": 9310,
  • "changedDate": "2019-03-21T17:32:12Z",
  • "startDate": "2019-02-01T17:32:12Z",
  • "endDate": "2090-02-01TT17:32:12Z",
  • "chainId": 9310,
  • "plenigoOfferId": "O_MZA1E7173120881551",
  • "invoiceCustomerId": "100003",
  • "deliveryCustomerId": "100003",
  • "term": 12,
  • "termTimeSpan": "MONTH",
  • "accountingPeriod": 1,
  • "accountingPeriodTimeSpan": "MONTH",
  • "cancellationPeriod": 1,
  • "cancellationPeriodTimeSpan": "DAY",
  • "currency": "EUR",
  • "paymentMethod": "CREDIT_CARD",
  • "paymentMethodId": 100230,
  • "accessBlocked": false,
  • "firstBookingDate": "2019-02-01",
  • "lastBookingDate": "2019-08-01",
  • "nextBookingDate": "2019-09-01",
  • "status": "ACTIVE",
  • "items": [
    ]
}

Change payment method

Change payment method of a subscription.

Authorizations:
sessionToken
path Parameters
subscriptionId
required
integer <int64>

unique id of the subscription

Request Body schema: application/json
paymentMethod
required
string
Enum: "AMAZON_PAY" "BANK_ACCOUNT" "BILLING" "CREDIT_CARD" "PAYPAL"

payment method used to pay for the subscription

paymentMethodId
required
integer <int64>

id of the payment method that is associated with this subscription

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "subscriptionId": 9310,
  • "changedDate": "2019-03-21T17:32:12Z",
  • "startDate": "2019-02-01T17:32:12Z",
  • "endDate": "2090-02-01TT17:32:12Z",
  • "chainId": 9310,
  • "plenigoOfferId": "O_MZA1E7173120881551",
  • "invoiceCustomerId": "100003",
  • "deliveryCustomerId": "100003",
  • "term": 12,
  • "termTimeSpan": "MONTH",
  • "accountingPeriod": 1,
  • "accountingPeriodTimeSpan": "MONTH",
  • "cancellationPeriod": 1,
  • "cancellationPeriodTimeSpan": "DAY",
  • "currency": "EUR",
  • "paymentMethod": "CREDIT_CARD",
  • "paymentMethodId": 100230,
  • "accessBlocked": false,
  • "firstBookingDate": "2019-02-01",
  • "lastBookingDate": "2019-08-01",
  • "nextBookingDate": "2019-09-01",
  • "status": "ACTIVE",
  • "items": [
    ]
}

Pause subscription

Pause a subscription during the given time range. Only subscriptions with the same accounting period and term can be paused.

Authorizations:
sessionToken
path Parameters
subscriptionId
required
integer <int64>

unique id of the subscription

Request Body schema: application/json
startPauseDate
required
string or null <date>

date subscription pause should be start with full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

endPauseDate
required
string or null <date>

date subscription pause should be end with full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

pauseType
string
Enum: "PAYMENT_ONLY" "STANDARD"

type of the pause

Responses

Request samples

Content type
application/json
{
  • "startPauseDate": "2019-02-01",
  • "endPauseDate": "2019-02-21"
}

Response samples

Content type
application/json
{
  • "subscriptionId": 9310,
  • "changedDate": "2019-03-21T17:32:12Z",
  • "startDate": "2019-02-01T17:32:12Z",
  • "endDate": "2090-02-01TT17:32:12Z",
  • "chainId": 9310,
  • "plenigoOfferId": "O_MZA1E7173120881551",
  • "invoiceCustomerId": "100003",
  • "deliveryCustomerId": "100003",
  • "term": 12,
  • "termTimeSpan": "MONTH",
  • "accountingPeriod": 1,
  • "accountingPeriodTimeSpan": "MONTH",
  • "cancellationPeriod": 1,
  • "cancellationPeriodTimeSpan": "DAY",
  • "currency": "EUR",
  • "paymentMethod": "CREDIT_CARD",
  • "paymentMethodId": 100230,
  • "accessBlocked": false,
  • "firstBookingDate": "2019-02-01",
  • "lastBookingDate": "2019-08-01",
  • "nextBookingDate": "2019-09-01",
  • "status": "ACTIVE",
  • "items": [
    ]
}

Delete a pause subscriptions

Delete the pause of a subscription.

Authorizations:
sessionToken
path Parameters
subscriptionId
required
integer <int64>

unique id of the subscription

Responses

Response samples

Content type
application/json
{
  • "subscriptionId": 9310,
  • "changedDate": "2019-03-21T17:32:12Z",
  • "startDate": "2019-02-01T17:32:12Z",
  • "endDate": "2090-02-01TT17:32:12Z",
  • "chainId": 9310,
  • "plenigoOfferId": "O_MZA1E7173120881551",
  • "invoiceCustomerId": "100003",
  • "deliveryCustomerId": "100003",
  • "term": 12,
  • "termTimeSpan": "MONTH",
  • "accountingPeriod": 1,
  • "accountingPeriodTimeSpan": "MONTH",
  • "cancellationPeriod": 1,
  • "cancellationPeriodTimeSpan": "DAY",
  • "currency": "EUR",
  • "paymentMethod": "CREDIT_CARD",
  • "paymentMethodId": 100230,
  • "accessBlocked": false,
  • "firstBookingDate": "2019-02-01",
  • "lastBookingDate": "2019-08-01",
  • "nextBookingDate": "2019-09-01",
  • "status": "ACTIVE",
  • "items": [
    ]
}

Get possible pause dates

Get possible pause dates of a running subscription.

Authorizations:
sessionToken
path Parameters
subscriptionId
required
integer <int64>

unique id of the subscription

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Pause delivery

Pause a subscription delivery during the given time range.

Authorizations:
sessionToken
path Parameters
subscriptionId
required
integer <int64>

unique id of the subscription

Request Body schema: application/json
startPauseDate
required
string or null <date>

date subscription pause should be start with full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

endPauseDate
required
string or null <date>

date subscription pause should be end with full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

pauseType
string
Enum: "PAYMENT_ONLY" "STANDARD"

type of the pause

Responses

Request samples

Content type
application/json
{
  • "startPauseDate": "2019-02-01",
  • "endPauseDate": "2019-02-21"
}

Response samples

Content type
application/json
{
  • "subscriptionId": 9310,
  • "changedDate": "2019-03-21T17:32:12Z",
  • "startDate": "2019-02-01T17:32:12Z",
  • "endDate": "2090-02-01TT17:32:12Z",
  • "chainId": 9310,
  • "plenigoOfferId": "O_MZA1E7173120881551",
  • "invoiceCustomerId": "100003",
  • "deliveryCustomerId": "100003",
  • "term": 12,
  • "termTimeSpan": "MONTH",
  • "accountingPeriod": 1,
  • "accountingPeriodTimeSpan": "MONTH",
  • "cancellationPeriod": 1,
  • "cancellationPeriodTimeSpan": "DAY",
  • "currency": "EUR",
  • "paymentMethod": "CREDIT_CARD",
  • "paymentMethodId": 100230,
  • "accessBlocked": false,
  • "firstBookingDate": "2019-02-01",
  • "lastBookingDate": "2019-08-01",
  • "nextBookingDate": "2019-09-01",
  • "status": "ACTIVE",
  • "items": [
    ]
}

Delete a pause delivery

Delete the pause of a subscription delivery.

Authorizations:
sessionToken
path Parameters
subscriptionId
required
integer <int64>

unique id of the subscription

Responses

Response samples

Content type
application/json
{
  • "subscriptionId": 9310,
  • "changedDate": "2019-03-21T17:32:12Z",
  • "startDate": "2019-02-01T17:32:12Z",
  • "endDate": "2090-02-01TT17:32:12Z",
  • "chainId": 9310,
  • "plenigoOfferId": "O_MZA1E7173120881551",
  • "invoiceCustomerId": "100003",
  • "deliveryCustomerId": "100003",
  • "term": 12,
  • "termTimeSpan": "MONTH",
  • "accountingPeriod": 1,
  • "accountingPeriodTimeSpan": "MONTH",
  • "cancellationPeriod": 1,
  • "cancellationPeriodTimeSpan": "DAY",
  • "currency": "EUR",
  • "paymentMethod": "CREDIT_CARD",
  • "paymentMethodId": 100230,
  • "accessBlocked": false,
  • "firstBookingDate": "2019-02-01",
  • "lastBookingDate": "2019-08-01",
  • "nextBookingDate": "2019-09-01",
  • "status": "ACTIVE",
  • "items": [
    ]
}

Get by chain

Get all subscriptions that belong to a specific subscription chain that is identified by the passed chain id.

Authorizations:
sessionToken
path Parameters
chainId
required
integer <int64>

unique id of the subscription chain

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get additional chain data

Returns additional data associated with the chain associated with the provided chain id.

Authorizations:
sessionToken
path Parameters
chainId
required
integer <int64>

unique id of the subscription chain

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get cross client

Get cross client subscription that is identified by the passed subscription id.

Authorizations:
sessionToken
path Parameters
subscriptionId
required
integer <int64>

unique id of the subscription

Responses

Response samples

Content type
application/json
{
  • "subscriptionId": 9310,
  • "changedDate": "2019-03-21T17:32:12Z",
  • "startDate": "2019-02-01T17:32:12Z",
  • "endDate": "2090-02-01TT17:32:12Z",
  • "chainId": 9310,
  • "plenigoOfferId": "O_MZA1E7173120881551",
  • "invoiceCustomerId": "100003",
  • "deliveryCustomerId": "100003",
  • "term": 12,
  • "termTimeSpan": "MONTH",
  • "accountingPeriod": 1,
  • "accountingPeriodTimeSpan": "MONTH",
  • "cancellationPeriod": 1,
  • "cancellationPeriodTimeSpan": "DAY",
  • "currency": "EUR",
  • "paymentMethod": "CREDIT_CARD",
  • "paymentMethodId": 100230,
  • "accessBlocked": false,
  • "firstBookingDate": "2019-02-01",
  • "lastBookingDate": "2019-08-01",
  • "nextBookingDate": "2019-09-01",
  • "status": "ACTIVE",
  • "items": [
    ]
}

Get cross client subscription by chain

Get all cross client subscriptions that belong to a specific subscription chain that is identified by the passed chain id.

Authorizations:
sessionToken
path Parameters
chainId
required
integer <int64>

unique id of the subscription chain

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Wallets

Get credit wallets

Get credit wallets.

Authorizations:
sessionToken
query Parameters
size
integer <int32> [ 5 .. 100 ]

amount of elements to return - if no size is provided or the size is not within range it will be automatically set to 5

startTime
string <date-time>

time the entity was changed after or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

endTime
string <date-time>

time the entity was changed before or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

startingAfter
string <= 100 characters

A cursor for use in pagination. startingAfter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include startingAfter=obj_foo in order to fetch the next result set.

endingBefore
string <= 100 characters

A cursor for use in pagination. endingBefore is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include endingBefore=obj_bar in order to fetch the previous page of the list.

sort
string <= 4 characters
Enum: "ASC" "DESC"

The sort of the search, if its desc it will revert to search for a lower startingAfter

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get credit wallet by unique id

Get credit wallet by unique id.

Authorizations:
sessionToken
path Parameters
uniqueId
required
string

unique id of the wallet

query Parameters
size
integer <int32> [ 5 .. 100 ]

amount of elements to return - if no size is provided or the size is not within range it will be automatically set to 5

startTime
string <date-time>

time the entity was changed after or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

endTime
string <date-time>

time the entity was changed before or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

startingAfter
string <= 100 characters

A cursor for use in pagination. startingAfter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include startingAfter=obj_foo in order to fetch the next result set.

endingBefore
string <= 100 characters

A cursor for use in pagination. endingBefore is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include endingBefore=obj_bar in order to fetch the previous page of the list.

sort
string <= 4 characters
Enum: "ASC" "DESC"

The sort of the search, if its desc it will revert to search for a lower startingAfter

Responses

Response samples

Content type
application/json
{
  • "items": {
    }
}

Get credit uploads

Get credit wallet uploads.

Authorizations:
sessionToken
path Parameters
uniqueId
required
string

unique id of the wallet

query Parameters
size
integer <int32> [ 5 .. 100 ]

amount of elements to return - if no size is provided or the size is not within range it will be automatically set to 5

startTime
string <date-time>

time the entity was changed after or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

endTime
string <date-time>

time the entity was changed before or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

startingAfter
string <= 100 characters

A cursor for use in pagination. startingAfter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include startingAfter=obj_foo in order to fetch the next result set.

endingBefore
string <= 100 characters

A cursor for use in pagination. endingBefore is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include endingBefore=obj_bar in order to fetch the previous page of the list.

sort
string <= 4 characters
Enum: "ASC" "DESC"

The sort of the search, if its desc it will revert to search for a lower startingAfter

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Get credit usages

Get credit wallet usages.

Authorizations:
sessionToken
path Parameters
uniqueId
required
string

unique id of the wallet

query Parameters
size
integer <int32> [ 5 .. 100 ]

amount of elements to return - if no size is provided or the size is not within range it will be automatically set to 5

startTime
string <date-time>

time the entity was changed after or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

endTime
string <date-time>

time the entity was changed before or equal with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

startingAfter
string <= 100 characters

A cursor for use in pagination. startingAfter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include startingAfter=obj_foo in order to fetch the next result set.

endingBefore
string <= 100 characters

A cursor for use in pagination. endingBefore is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include endingBefore=obj_bar in order to fetch the previous page of the list.

sort
string <= 4 characters
Enum: "ASC" "DESC"

The sort of the search, if its desc it will revert to search for a lower startingAfter

Responses

Response samples

Content type
application/json
{
  • "items": [
    ]
}

Customers

Get opt-ins

Get opt-ins of the customer.

Authorizations:
sessionToken

Responses

Response samples

Content type
application/json
{
  • "customerId": "string",
  • "optIns": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "changedDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "createdByType": "API",
  • "changedBy": "string",
  • "changedByType": "API"
}

Update opt-in

Update opt-ins of a customer.

Authorizations:
sessionToken
Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{
  • "optIns": {
    }
}

Response samples

Content type
application/json
{
  • "customerId": "string",
  • "optIns": {
    },
  • "createdDate": "2019-08-24T14:15:22Z",
  • "changedDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "createdByType": "API",
  • "changedBy": "string",
  • "changedByType": "API"
}