redocly logo API docs by Redocly

plenigo API v3 (API.241104-MINOR)

Download OpenAPI specification:Download

URL: https://github.com/plenigo/plenigo-doc

This is the OpenAPI description for accessing the plenigo platform. All API calls are by default synchronous. Asynchronous calls are marked.

Access Rights

Search access rights

Search all access rights that correspond to the given search conditions.

Authorizations:
plenigoToken
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
{
  • "startingAfterId": "100002",
  • "items": [
    ]
}

Get all customer access rights

Get all access rights for a customer identified by the passed customer id.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

Responses

Response samples

Content type
application/json
{
  • "customerId": "100003",
  • "customerBlocked": false,
  • "createdDate": "2019-01-01T07:53:23.450961Z",
  • "createdBy": "PLENIGO",
  • "createdByType": "SYSTEM",
  • "changedDate": "2019-01-01T07:53:23.450961Z",
  • "changedBy": "PLENIGO",
  • "changedByType": "SYSTEM",
  • "items": [
    ]
}

Create customer access right

Create a new access right item with the data provided for a customer identified by the passed customer id.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

Request Body schema: application/json
lifeTimeStart
string or null <date-time>

date the access right will start with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

lifeTimeEnd
string or null <date-time>

date the access right will end with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

accessTimeStart
string or null <date-time>

time the access right will start with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

accessTimeEnd
string or null <date-time>

time the access right will end with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

maxCacheDate
string or null <date-time>

max cache date with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

Array of objects
blocked
boolean

flag indicating if access is blocked

Responses

Request samples

Content type
application/json
{
  • "lifeTimeStart": "2019-01-01T07:53:23.450961Z",
  • "lifeTimeEnd": "2020-01-01T07:53:23.450961Z",
  • "accessTimeStart": "06:00:00",
  • "accessTimeEnd": "18:00:00",
  • "maxCacheDate": "2020-01-01T07:53:23.450961Z",
  • "data": [
    ],
  • "blocked": false
}

Response samples

Content type
application/json
{
  • "customerId": "100003",
  • "customerBlocked": false,
  • "createdDate": "2019-01-01T07:53:23.450961Z",
  • "createdBy": "PLENIGO",
  • "createdByType": "SYSTEM",
  • "changedDate": "2019-01-01T07:53:23.450961Z",
  • "changedBy": "PLENIGO",
  • "changedByType": "SYSTEM",
  • "items": [
    ]
}

Update customer access right

Updates an access right item with the data provided for a customer identified by the passed customer id.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

accessRightUniqueId
required
string

id of the access right item

Request Body schema: application/json
lifeTimeStart
string or null <date-time>

date the access right will start with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

lifeTimeEnd
string or null <date-time>

date the access right will end with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

accessTimeStart
string or null <date-time>

time the access right will start with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

accessTimeEnd
string or null <date-time>

time the access right will end with time notation as defined by RFC 3339, section 5.6, for example, 17:32:28

maxCacheDate
string or null <date-time>

max cache date with date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

Array of objects
blocked
boolean

flag indicating if access is blocked

Responses

Request samples

Content type
application/json
{
  • "lifeTimeStart": "2019-01-01T07:53:23.450961Z",
  • "lifeTimeEnd": "2020-01-01T07:53:23.450961Z",
  • "accessTimeStart": "06:00:00",
  • "accessTimeEnd": "18:00:00",
  • "maxCacheDate": "2020-01-01T07:53:23.450961Z",
  • "data": [
    ],
  • "blocked": false
}

Response samples

Content type
application/json
{
  • "customerId": "100003",
  • "customerBlocked": false,
  • "createdDate": "2019-01-01T07:53:23.450961Z",
  • "createdBy": "PLENIGO",
  • "createdByType": "SYSTEM",
  • "changedDate": "2019-01-01T07:53:23.450961Z",
  • "changedBy": "PLENIGO",
  • "changedByType": "SYSTEM",
  • "items": [
    ]
}

Delete customer access right

Delete an access right item for a customer identified by the passed customer id.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

accessRightUniqueId
required
string

id of the access right item

Responses

Response samples

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

Block customer access right item

Block an access right item of type EXTERNAL or SINGLE_PRODUCT for a customer.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

accessRightUniqueId
required
string

id of the access right item

itemId
required
string

item id of an access right item

Responses

Response samples

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

Unblock customer access right item

Unblock an access right item of type EXTERNAL or SINGLE_PRODUCT for a customer.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

accessRightUniqueId
required
string

id of the access right item

itemId
required
string

item id of an access right item

Responses

Response samples

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

Check customer has access

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

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

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": [
    ]
}

Activities

Search activities

Search all accounting forms that correspond to the given search conditions.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

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

jsonObjectType
string
Enum: "ACCESS_RIGHT_ITEM" "AMAZON_PAY" "BANK_ACCOUNT" "CREDIT_CARD" "CUSTOMER" "DELIVERY_ADDRESS" "INVOICE" "INVOICE_ADDRESS" "ORDER" "PAYPAL" "SUBSCRIPTION"

The type the activity belongs to.

jsonObjectIdentifier
string <= 100 characters

The identifier of the object the activity belongs to. Can only be used in combination with jsonObjectType

Responses

Response samples

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

Addresses

Search addresses

Search all addresses that correspond to the given search conditions.

Authorizations:
plenigoToken
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:
plenigoToken
query Parameters
overrideValidation
boolean

flag if the validation should be ignored

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:
plenigoToken
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:
plenigoToken
path Parameters
addressId
required
integer <int64>

unique id of the address

query Parameters
overrideValidation
boolean

flag if the validation should be ignored

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:
plenigoToken
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:
plenigoToken
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:
plenigoToken
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:
plenigoToken
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:
plenigoToken
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
}

Validate address by id

Important note: The use of these API endpoints is a chargeable service provided by plenigo GmbH. The billing is done according to the current price list, which you can find in the settings section of your plenigo account. The billing is done with the monthly invoice.

Validates the address with the given id.

Authorizations:
plenigoToken
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"
}

Create wbz address

Create a new wbz address with the data provided.

Authorizations:
plenigoToken
query Parameters
overrideValidation
boolean

flag if the validation should be ignored

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

unique id of the customer the address belongs to

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"
}

Validate address data

Important note: The use of these API endpoints is a chargeable service provided by plenigo GmbH. The billing is done according to the current price list, which you can find in the settings section of your plenigo account. The billing is done with the monthly invoice. Validates the address with the data provided.

Authorizations:
plenigoToken
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"
}

Corporate Accounts

Search corporate accounts

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

Authorizations:
plenigoToken
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.

corporateAccountId
integer <int64>

unique id of the corporate account

Responses

Response samples

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

Get corporate accounts

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

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

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 for customer

Get the corporate account of the customer.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

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:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

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:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

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:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

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
}

Use corporate account code

Use a corporate account user code.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

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
{
  • "success": true
}

Validate

Check if a corporate account user code is valid.

Authorizations:
plenigoToken
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"
}

Customers

Search customers

Search all customers that correspond to the given search conditions. It is important to note that email, username, and externalSystemid exclude each other so only one query parameter is used. The defined priority is email, username, externalSystemId.

Authorizations:
plenigoToken
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

externalSystemId
string

external system id defined by third party systems

email
string <email>

email to search for

username
string

username to search for

Responses

Response samples

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

Create customer

Create a new customer with the data provided.

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

unique id of the customer

registrationSource
string <= 100 characters

domain, website, app or other source of the customer registration

password
string <= 100 characters

password the new customer should get

sendWelcomeMail
boolean

flag indicating if welcome mail for customer should be sent

Array of objects (CustomerAddressCreation)

addresses that should be directly associated with the customer

object (AdditionalCustomerData)
pseudoEmail
boolean

flag indicating that email should be a pseudo email

processingBlocked
boolean

Flag to indicate to third party systems that the customer is blocked for further processing and should not be used for advertisement, etc. Can be used in combination with the pseudoEmail flag to handle data protection requests without deletion of a customer.

username
string <= 100 characters

selected username of the customer that is unique for all users

email
required
string <email> <= 100 characters

email address of the customer that is unique for all users

externalSystemId
string <= 100 characters

external system id - can only be set if not set yet

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

invoiceEmail
string <email> <= 100 characters

email address of the customer where invoices should be sent to

language
required
string = 2 characters

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

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

mobile number of the customer formatted as E.164

birthday
string or null <date>

birthday of the customer with full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-01

object (CustomerMiscellaneousData)

Responses

Request 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",
  • "addresses": [
    ],
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "customerId": "100003",
  • "externalSystemId": "1748-E",
  • "username": "wild_flower",
  • "email": "wildflower@example.com",
  • "salutation": "MR",
  • "firstName": "John",
  • "lastName": "Doe",
  • "invoiceEmail": "wildflower-invoices@example.com",
  • "birthday": "2001-03-21",
  • "language": "de",
  • "mobileNumber": "+14155552671",
  • "status": "ACTIVATED",
  • "changedDate": "2019-03-21T17:32:12Z",
  • "registrationDate": "2019-03-21T17:32:12Z",
  • "registrationSource": "www.example.com",
  • "twoFactorEnabled": false,
  • "addresses": [
    ],
  • "data": {
    }
}

Search additional data

Search all additional data of customers.

Authorizations:
plenigoToken
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 customer

Get customer that is identified by the passed customer id.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

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": {
    }
}

Update

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

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

Request Body schema: application/json
pseudoEmail
boolean

flag indicating that email should be a pseudo email

password
string <= 100 characters

new password of the user - if left empty the old password will be kept

processingBlocked
boolean

Flag to indicate to third party systems that the customer is blocked for further processing and should not be used for advertisement, etc. Can be used in combination with the pseudoEmail flag to handle data protection requests without deletion of a customer.

username
string <= 100 characters

selected username of the customer that is unique for all users

email
string <email> <= 100 characters

email address of the customer that is unique for all users

externalSystemId
string <= 100 characters

external system id - can only be set if not set yet

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

invoiceEmail
string <email> <= 100 characters

email address of the customer where invoices should be sent to

language
string = 2 characters

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

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

mobile number of the customer formatted as E.164

birthday
string or null <date>

birthday of the customer with full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-01

object (CustomerMiscellaneousData)

Responses

Request samples

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

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": {
    }
}

Delete customer

Delete a customer. This is only possible if customer has no payments done yet.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

query Parameters
forceDeletion
boolean

flag indicating if force deletion

Responses

Response samples

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

Get access rights

Get access rights associated with a customer.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

Responses

Response samples

Content type
application/json
{
  • "customerId": "100003",
  • "customerBlocked": false,
  • "createdDate": "2019-01-01T07:53:23.450961Z",
  • "createdBy": "PLENIGO",
  • "createdByType": "SYSTEM",
  • "changedDate": "2019-01-01T07:53:23.450961Z",
  • "changedBy": "PLENIGO",
  • "changedByType": "SYSTEM",
  • "items": [
    ]
}

Get additional data

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

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

Responses

Response samples

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

Replace additional data

Replace additional data of a customer. All data will be replaced with the new data provided.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

Request Body schema: application/json
object

Responses

Request samples

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

Response samples

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

Search customer's app store orders

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

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

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 customer's app store subscriptions

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

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

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 customer's addresses

Search all addresses that correspond to the given search conditions and belong to the customer identified by the customer id provided.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

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": [
    ]
}

Dissociates all app store purchases

Dissociates all app store purchases of a customer.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

Responses

Response samples

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

Change email

Changes a customer's email

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

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

email address

Responses

Request samples

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

Response samples

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

Create GDPR data

ASYNC Every call to this endpoint will return a promise ID and create a GDPR request callback that contains the customer data requested. The callback also returns the promise ID returned by this call to be identified. This endpoint is highly limited because of its expensive nature. You can only call it three times every five seconds. Unlimited requests can be done by an agent via the plenigo merchant backend.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "promiseId": "0ujsszgFvbiEr7CDgE3z8MAUPFt"
}

Search customer's invoices

Search all invoices that correspond to the given search conditions and belong to the customer identified by the customer id provided.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

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": [
    ]
}

Change invoice email

Changes a customer's invoice email

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

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

invoice email address

Responses

Request samples

Content type
application/json
{
  • "invoiceEmail": "invoice@example.com"
}

Response samples

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

Search customer's foreign orders

Search all foreign orders that correspond to the given search conditions and belong to the customer identified by the customer id provided.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

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 opt-in

Get opt-ins of the customer.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

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:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

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"
}

Search customer's orders

Search all orders that correspond to the given search conditions and belong to the customer identified by the customer id provided.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

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 customer's payment methods

Search all payment methods that correspond to the given search conditions and belong to the customer identified by the customer id provided.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

Responses

Response samples

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

Change status

Change the current status of a customer

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

Request Body schema: application/json
status
string
Enum: "ACTIVATED" "BLOCKED" "DEACTIVATED"

new status the customer should become

Status Description
ACTIVATED customer is active and can log in and use full functionality
BLOCKED customer is blocked and needs to reset his password to be able to log in again
DEACTIVATED customer is deactivated and cannot log in - the customer cannot change this state by himself and a log in attempt is handled like a false password log in

Responses

Request samples

Content type
application/json
{
  • "status": "BLOCKED"
}

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": {
    }
}

Get customer status history

Returns status history associated with the customer associated with the provided customer id.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

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.

Responses

Response samples

Content type
application/json
{
  • "statusChangeId": 0,
  • "customerId": "string",
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "oldStatus": "ACTIVATED",
  • "newStatus": "ACTIVATED",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "changedDate": "2019-08-24T14:15:22Z"
}

Search customer's subscriptions

Search all subscriptions that correspond to the given search conditions and belong to the customer identified by the customer id provided.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

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 customer's cross client subscriptions

Search all cross client subscriptions that correspond to the given search conditions and belong to the customer identified by the customer id provided.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

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 customer's transactions

Search all transactions that correspond to the given search conditions and belong to the customer identified by the customer id provided.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

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 customer credit wallets

Get customer credit wallets.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

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.

Responses

Response samples

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

Search customers failed login attempts

Search all failed login attempts that correspond to the given search conditions.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

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
{
  • "failedCustomerLogInId": 0,
  • "customerId": "string",
  • "loginDate": "2019-08-24T14:15:22Z",
  • "browser": "string",
  • "os": "string",
  • "source": "string",
  • "sourceUrl": "string",
  • "country": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "changedDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "createdByType": "API",
  • "changedBy": "string",
  • "changedByType": "API"
}

Search customers successful login attempts

Search all successful login attempts that correspond to the given search conditions.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

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
{
  • "customerLogInId": 0,
  • "customerId": "string",
  • "loginDate": "2019-08-24T14:15:22Z",
  • "browser": "string",
  • "os": "string",
  • "source": "string",
  • "sourceUrl": "string",
  • "country": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "changedDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "createdByType": "API",
  • "changedBy": "string",
  • "changedByType": "API"
}

Create Stripe customer

Create a stripe customer association for a customer

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

Request Body schema: application/json
stripeId
string <= 20 characters

Stripe id of the customer

Responses

Request samples

Content type
application/json
{
  • "stripeId": "cus_9s6XGDTHzA66Po"
}

Response samples

Content type
application/json
{
  • "stripeId": "cus_9s6XGDTHzA66Po",
  • "customerId": "12341234123"
}

Deletes a Stripe customer

Deletes a Stripe customer if no payment method is associated yet. Also the customer within the Stripe system will be removed if there are no other payment methods associated with.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

Responses

Response samples

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

Change username

Changes a customer's username

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

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

username

Responses

Request samples

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

Response samples

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

Get customer marks

Get the customer marks.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

Responses

Response samples

Content type
application/json
{
  • "customerId": "string",
  • "tags": {
    }
}

Get customer mark data

Get the customer mark data.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

customerMark
required
string
Value: "WBZ"

customer mark

Responses

Response samples

Content type
application/json
{
  • "createdDate": "2019-08-24T14:15:22Z",
  • "changedDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "createdByType": "API",
  • "changedBy": "string",
  • "changedByType": "API",
  • "dealerGroup": "string",
  • "dealerNumber": "string",
  • "agencyPrice": 0,
  • "basePrice": 0,
  • "exitLiability": 0,
  • "startWkzA": 0,
  • "startWkzB": 0,
  • "startWkzC": 0,
  • "scaleWkzA": 0,
  • "scaleWkzB": 0,
  • "scaleWkzC": 0,
  • "data": {
    }
}

Update customer mark data

Update customer mark data.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

customerMark
required
string
Value: "WBZ"

customer mark

Request Body schema: application/json
dealerGroup
required
string <= 200 characters

wbz dealer group

dealerNumber
required
string <= 200 characters

wbz dealer number

agencyPrice
number <double>

the agency price

basePrice
number <double>

the base price

exitLiability
integer <int32>

exitLiability

startWkzA
number <double>

start WKZ-A price

startWkzB
number <double>

start WKZ-B price

startWkzC
number <double>

start WKZ-C price

scaleWkzA
number <double>

scale WKZ-A price

scaleWkzB
number <double>

scale WKZ-B price

scaleWkzC
number <double>

scale WKZ-C price

object

Responses

Request samples

Content type
application/json
{
  • "dealerGroup": "string",
  • "dealerNumber": "string",
  • "agencyPrice": 0,
  • "basePrice": 0,
  • "exitLiability": 0,
  • "startWkzA": 0,
  • "startWkzB": 0,
  • "startWkzC": 0,
  • "scaleWkzA": 0,
  • "scaleWkzB": 0,
  • "scaleWkzC": 0,
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "createdDate": "2019-08-24T14:15:22Z",
  • "changedDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "createdByType": "API",
  • "changedBy": "string",
  • "changedByType": "API",
  • "dealerGroup": "string",
  • "dealerNumber": "string",
  • "agencyPrice": 0,
  • "basePrice": 0,
  • "exitLiability": 0,
  • "startWkzA": 0,
  • "startWkzB": 0,
  • "startWkzC": 0,
  • "scaleWkzA": 0,
  • "scaleWkzB": 0,
  • "scaleWkzC": 0,
  • "data": {
    }
}

Get internal customer id

Get customer id by external system

Authorizations:
plenigoToken
path Parameters
externalSystemId
required
string

external system id defined by third party systems

Responses

Response samples

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

Search customers failed login attempts

Search all failed login attempts that correspond to the given search conditions.

Authorizations:
plenigoToken
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
{
  • "failedCustomerLogInId": 0,
  • "customerId": "string",
  • "loginDate": "2019-08-24T14:15:22Z",
  • "browser": "string",
  • "os": "string",
  • "source": "string",
  • "sourceUrl": "string",
  • "country": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "changedDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "createdByType": "API",
  • "changedBy": "string",
  • "changedByType": "API"
}

Search customers successful login attempts

Search all successful login attempts that correspond to the given search conditions.

Authorizations:
plenigoToken
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
{
  • "customerLogInId": 0,
  • "customerId": "string",
  • "loginDate": "2019-08-24T14:15:22Z",
  • "browser": "string",
  • "os": "string",
  • "source": "string",
  • "sourceUrl": "string",
  • "country": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "changedDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "createdByType": "API",
  • "changedBy": "string",
  • "changedByType": "API"
}

Search opt-ins

Search opt-ins of a company.

Authorizations:
plenigoToken
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.

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": [
    ]
}

Payment Methods

Search amazon pay account

Search all amazon pay accounts that correspond to the given search conditions

Authorizations:
plenigoToken
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 an amazon pay account entity

Create a new amazon pay account with the data provided.

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

unique id of the customer the amazon pay account belongs to

createdAt
string or null <date-time>

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

updatedAt
string or null <date-time>

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

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",
  • "customerId": "100003",
  • "createdAt": "2019-03-21T17:32:12Z",
  • "updatedAt": "2019-03-21T17:32:12Z",
  • "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 an amazon pay account entity

Get amazon pay account that is identified by the passed amazon pay account id.

Authorizations:
plenigoToken
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 amazon pay account entity

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

Authorizations:
plenigoToken
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 an amazon pay account

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

Authorizations:
plenigoToken
path Parameters
amazonPayAccountId
required
integer <int64>

unique id of the AmazonPay account

Responses

Response samples

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

Search bank account

Search all bank accounts that correspond to the given search conditions

Authorizations:
plenigoToken
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 a bank account entity

Create a new bank account with the data provided.

Authorizations:
plenigoToken
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
}

Get a bank account entity

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

Authorizations:
plenigoToken
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 entity

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

Authorizations:
plenigoToken
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
{
  • "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
}

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 a 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:
plenigoToken
path Parameters
bankAccountId
required
integer <int64>

unique id of the bank account

Responses

Response samples

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

Search credit card

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

Authorizations:
plenigoToken
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 a credit card

Create a new credit card with the data provided.

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

unique id of the customer the credit card belongs to

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
{
  • "customerId": "100003",
  • "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 a credit card entity

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

Authorizations:
plenigoToken
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 a credit card entity

Update credit card that is identified by the passed address id with the data provided.

Authorizations:
plenigoToken
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 a 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:
plenigoToken
path Parameters
creditCardId
required
integer <int64>

unique id of the credit card

Responses

Response samples

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

Search iDeal account

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

Authorizations:
plenigoToken
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:
plenigoToken
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:
plenigoToken
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:
plenigoToken
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:
plenigoToken
path Parameters
iDealAccountId
required
integer <int64>

unique id of the iDeal account

Responses

Response samples

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

Search PayPal account

Search all PayPal accounts that correspond to the given search conditions

Authorizations:
plenigoToken
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 a PayPal account entity

Create a new PayPal account with the data provided.

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

unique id of the customer the PayPal account belongs to

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
{
  • "customerId": "83432341",
  • "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 a PayPal account entity

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

Authorizations:
plenigoToken
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
}

Delete a PayPal account

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

Authorizations:
plenigoToken
path Parameters
payPalAccountId
required
integer <int64>

unique id of the PayPal account

Responses

Response samples

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

Search PostFinance account

Search all PostFinance accounts that correspond to the given search conditions

Authorizations:
plenigoToken
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 a PostFinance account entity

Create a new PostFinance account with the data provided.

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

unique id of the customer the PostFinance account belongs to

createdAt
string or null <date-time>

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

updatedAt
string or null <date-time>

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

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",
  • "customerId": "100003",
  • "createdAt": "2019-03-21T17:32:12Z",
  • "updatedAt": "2019-03-21T17:32:12Z",
  • "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 a PostFinance account entity

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

Authorizations:
plenigoToken
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
}

Delete a PostFinance account

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

Authorizations:
plenigoToken
path Parameters
postFinanceAccountId
required
integer <int64>

unique id of the PostFinance account

Responses

Response samples

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

Search Twint account

Search all Twint accounts that correspond to the given search conditions

Authorizations:
plenigoToken
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 a Twint account entity

Create a new Twint account with the data provided.

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

unique id of the customer the Twint account belongs to

createdAt
string or null <date-time>

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

updatedAt
string or null <date-time>

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

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",
  • "customerId": "100003",
  • "createdAt": "2019-03-21T17:32:12Z",
  • "updatedAt": "2019-03-21T17:32:12Z",
  • "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 a Twint account entity

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

Authorizations:
plenigoToken
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
}

Delete a Twint account

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

Authorizations:
plenigoToken
path Parameters
twintAccountId
required
integer <int64>

unique id of the Twint account

Responses

Response samples

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

Sessions

Get customer data

Provides customer data details for the currently active session. Includes the complete customer and her preferred invoice and delivery addresses if available.

Authorizations:
plenigoToken
query Parameters
sessionToken
required
string <= 10000 characters

active customer session

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": {
    }
}

Validate

Validates a customer session and returns the session information in case of a valid session.

Authorizations:
plenigoToken
query Parameters
sessionToken
required
string <= 10000 characters

active customer session

Responses

Response samples

Content type
application/json
{
  • "id": "0ujssxh0cECutqzMgbtXSGnjorm",
  • "customerId": "6342000",
  • "contractCompanyId": "xhzTmlZgnSQ6LpzkRGvK",
  • "companyId": "aHgTmlZgnSQ6LpzkRGvK",
  • "created": "2019-01-01T07:53:23.450961Z",
  • "type": "CUSTOMER_SESSION"
}

Create customer session

Creates a new customer session for the provided customer id. More information provided during the session creation process will lead to a better session protection and also helps the user to identify which session he wants to remove if multiple parallel log ins are allowed and the maximum active session limit is reached.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

Request Body schema: application/json
os
string <= 100 characters

operating system session was created on

browser
string <= 200 characters

browser session was created in

source
string <= 200 characters

source domain or app name

sourceUrl
string <= 2000 characters

source url

ipAddress
string <= 45 characters

ip address

country
string <= 2 characters

country code formatted as ISO 3166-1 alpha-2

Responses

Request samples

Content type
application/json
{
  • "browser": "Mozilla/5.0 (Android 4.4; Mobile; rv:41.0) Gecko/41.0 Firefox/41.0",
  • "os": "Android 4.4",
  • "source": "www.example.com",
  • "sourceUrl": "https://www.example.com/help",
  • "ipAddress": "127.0.0.1",
  • "country": "GB"
}

Response samples

Content type
application/json
{
  • "activeSessions": {
    },
  • "removalToken": "2ujsszwN8NRY24YaXiTIE2VWDTE"
}

Create Transfer Token

Creates a new transfer token that enables to transfer a customer session e.g. via Javascript without letting other Javascripts to catch the actual user session. A transfer token is only valid one time and for 30 seconds.

Authorizations:
plenigoToken
Request Body schema: application/json
customerSession
string

customer session string to be provided for all functionality that needs an active customer session - the string size can be very long so don't set any length restrictions if saved within a database or something similar

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "transferToken": "0ujssxh0cECutqzMgbtXSGnjorm"
}

Validate Transfer Token

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

Authorizations:
plenigoToken
query Parameters
transferToken
required
string <= 50 characters

transfer token

Responses

Response samples

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

Accounting

Search cost centers

Search all cost centers that correspond to the given search conditions.

Authorizations:
plenigoToken
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 cost center

Create a new cost center with the data provided.

Authorizations:
plenigoToken
Request Body schema: application/json
costCenter
string <= 10 characters

Cost center value of the cost center

purchaseNumber
string <= 20 characters

Purchase number to use

description
string <= 400 characters

description of the cost center

shortDescription
string <= 20 characters

short description of the cost center

Responses

Request samples

Content type
application/json
{
  • "costCenter": "12345678",
  • "description": "Default cost center",
  • "shortDescription": "Default CC"
}

Response samples

Content type
application/json
{
  • "costCenterId": 100001,
  • "costCenter": "12345678",
  • "description": "Default cost center",
  • "shortDescription": "Default CC"
}

Get cost center

Get cost center that is identified by the passed cost center id.

Authorizations:
plenigoToken
path Parameters
costCenterId
required
integer <int64>

unique id of the cost center

Responses

Response samples

Content type
application/json
{
  • "costCenterId": 100001,
  • "costCenter": "12345678",
  • "description": "Default cost center",
  • "shortDescription": "Default CC"
}

Update cost center

Update a cost center that is identified by the passed cost center id with the data provided.

Authorizations:
plenigoToken
path Parameters
costCenterId
required
integer <int64>

unique id of the cost center

Request Body schema: application/json
costCenter
string <= 10 characters

Cost center value of the cost center

purchaseNumber
string <= 20 characters

Purchase number to use

description
string <= 400 characters

description of the cost center

shortDescription
string <= 20 characters

short description of the cost center

Responses

Request samples

Content type
application/json
{
  • "costCenter": "12345678",
  • "description": "Default cost center",
  • "shortDescription": "Default CC"
}

Response samples

Content type
application/json
{
  • "costCenterId": 100001,
  • "costCenter": "12345678",
  • "description": "Default cost center",
  • "shortDescription": "Default CC"
}

Search ledgers

Search all ledgers that correspond to the given search conditions.

Authorizations:
plenigoToken
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 ledger

Create a new ledger with the data provided.

Authorizations:
plenigoToken
Request Body schema: application/json
title
required
string <= 100 characters

Title of the ledger

description
string <= 400 characters

description of the ledger

deliveryCommitmentAccount
string <= 80 characters

delivery commitment account of the ledger

voucherDeliveryCommitmentAccount
string <= 80 characters

voucher delivery commitment account of the ledger

revenueAccount
string <= 80 characters

revenue account of the ledger

bankAccountAmazonPay
string <= 80 characters

bank account for Amazon Pay of the ledger

bankAccountApplePay
string <= 80 characters

bank account for Apple Pay of the ledger

bankAccountBilling
string <= 80 characters

bank account for billing of the ledger

bankAccountCreditCard
string <= 80 characters

bank account for credit card of the ledger

bankAccountGooglePay
string <= 80 characters

bank account for Google Pay of the ledger

bankAccountPayPal
string <= 80 characters

bank account for PayPal of the ledger

bankAccountSepa
string <= 80 characters

bank account for sepa of the ledger

creditLossAccount
string <= 80 characters

credit loss account of the ledger

salesTax
string <= 80 characters

sales tax account of the ledger

b2bDeliveryCommitmentAccount
string <= 80 characters

b2b delivery commitment account of the ledger

b2bVoucherDeliveryCommitmentAccount
string <= 80 characters

b2b voucher delivery commitment account of the ledger

b2bRevenueAccount
string <= 80 characters

b2b revenue account of the ledger

b2bBankAccountAmazonPay
string <= 80 characters

b2b bank account for Amazon Pay of the ledger

b2bBankAccountApplePay
string <= 80 characters

b2b bank account for Apple Pay of the ledger

b2bBankAccountBilling
string <= 80 characters

b2b bank account for billing of the ledger

b2bBankAccountCreditCard
string <= 80 characters

b2b bank account for credit card of the ledger

b2bBankAccountGooglePay
string <= 80 characters

b2b bank account for Google Pay of the ledger

b2bBankAccountPayPal
string <= 80 characters

b2b bank account for PayPal of the ledger

b2bBankAccountSepa
string <= 80 characters

b2b bank account for sepa of the ledger

b2bCreditLossAccount
string <= 80 characters

b2b credit loss account of the ledger

b2bSalesTax
string <= 80 characters

b2b sales tax account of the ledger

object

custom accountings of the ledger

Responses

Request samples

Content type
application/json
{
  • "title": "A ledger title",
  • "description": "Default ledger description",
  • "deliveryCommitmentAccount": "4400",
  • "voucherDeliveryCommitmentAccount": "4401",
  • "revenueAccount": "5000",
  • "bankAccountAmazonPay": "2804",
  • "bankAccountApplePay": "2805",
  • "bankAccountBilling": "2800",
  • "bankAccountCreditCard": "2802",
  • "bankAccountGooglePay": "2806",
  • "bankAccountPayPal": "2803",
  • "bankAccountSepa": "2801",
  • "creditLossAccount": "3670",
  • "salesTax": "4800",
  • "b2bDeliveryCommitmentAccount": "4402",
  • "b2bVoucherDeliveryCommitmentAccount": "4403",
  • "b2bRevenueAccount": "5001",
  • "b2bBankAccountAmazonPay": "2814",
  • "b2bBankAccountApplePay": "2815",
  • "b2bBankAccountBilling": "2810",
  • "b2bBankAccountCreditCard": "2812",
  • "b2bBankAccountGooglePay": "2816",
  • "b2bBankAccountPayPal": "2813",
  • "b2bBankAccountSepa": "2811",
  • "b2bCreditLossAccount": "3671",
  • "b2bSalesTax": "4801"
}

Response samples

Content type
application/json
{
  • "ledgerId": 100001,
  • "title": "A ledger title",
  • "description": "Default ledger description",
  • "deliveryCommitmentAccount": "4400",
  • "voucherDeliveryCommitmentAccount": "4401",
  • "revenueAccount": "5000",
  • "bankAccountAmazonPay": "2804",
  • "bankAccountApplePay": "2805",
  • "bankAccountBilling": "2800",
  • "bankAccountCreditCard": "2802",
  • "bankAccountGooglePay": "2806",
  • "bankAccountPayPal": "2803",
  • "bankAccountSepa": "2801",
  • "creditLossAccount": "3670",
  • "salesTax": "4800",
  • "b2bDeliveryCommitmentAccount": "4402",
  • "b2bVoucherDeliveryCommitmentAccount": "4403",
  • "b2bRevenueAccount": "5001",
  • "b2bBankAccountAmazonPay": "2814",
  • "b2bBankAccountApplePay": "2815",
  • "b2bBankAccountBilling": "2810",
  • "b2bBankAccountCreditCard": "2812",
  • "b2bBankAccountGooglePay": "2816",
  • "b2bBankAccountPayPal": "2813",
  • "b2bBankAccountSepa": "2811",
  • "b2bCreditLossAccount": "3671",
  • "b2bSalesTax": "4801"
}

Get ledger

Get ledger that is identified by the passed ledger id.

Authorizations:
plenigoToken
path Parameters
ledgerId
required
integer <int64>

unique id of the ledger

Responses

Response samples

Content type
application/json
{
  • "ledgerId": 100001,
  • "title": "A ledger title",
  • "description": "Default ledger description",
  • "deliveryCommitmentAccount": "4400",
  • "voucherDeliveryCommitmentAccount": "4401",
  • "revenueAccount": "5000",
  • "bankAccountAmazonPay": "2804",
  • "bankAccountApplePay": "2805",
  • "bankAccountBilling": "2800",
  • "bankAccountCreditCard": "2802",
  • "bankAccountGooglePay": "2806",
  • "bankAccountPayPal": "2803",
  • "bankAccountSepa": "2801",
  • "creditLossAccount": "3670",
  • "salesTax": "4800",
  • "b2bDeliveryCommitmentAccount": "4402",
  • "b2bVoucherDeliveryCommitmentAccount": "4403",
  • "b2bRevenueAccount": "5001",
  • "b2bBankAccountAmazonPay": "2814",
  • "b2bBankAccountApplePay": "2815",
  • "b2bBankAccountBilling": "2810",
  • "b2bBankAccountCreditCard": "2812",
  • "b2bBankAccountGooglePay": "2816",
  • "b2bBankAccountPayPal": "2813",
  • "b2bBankAccountSepa": "2811",
  • "b2bCreditLossAccount": "3671",
  • "b2bSalesTax": "4801"
}

Update ledger

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

Authorizations:
plenigoToken
path Parameters
ledgerId
required
integer <int64>

unique id of the ledger

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

Title of the ledger

description
string <= 400 characters

description of the ledger

deliveryCommitmentAccount
string <= 80 characters

delivery commitment account of the ledger

voucherDeliveryCommitmentAccount
string <= 80 characters

voucher delivery commitment account of the ledger

revenueAccount
string <= 80 characters

revenue account of the ledger

bankAccountAmazonPay
string <= 80 characters

bank account for Amazon Pay of the ledger

bankAccountApplePay
string <= 80 characters

bank account for Apple Pay of the ledger

bankAccountBilling
string <= 80 characters

bank account for billing of the ledger

bankAccountCreditCard
string <= 80 characters

bank account for credit card of the ledger

bankAccountGooglePay
string <= 80 characters

bank account for Google Pay of the ledger

bankAccountPayPal
string <= 80 characters

bank account for PayPal of the ledger

bankAccountSepa
string <= 80 characters

bank account for sepa of the ledger

creditLossAccount
string <= 80 characters

credit loss account of the ledger

salesTax
string <= 80 characters

sales tax account of the ledger

b2bDeliveryCommitmentAccount
string <= 80 characters

b2b delivery commitment account of the ledger

b2bVoucherDeliveryCommitmentAccount
string <= 80 characters

b2b voucher delivery commitment account of the ledger

b2bRevenueAccount
string <= 80 characters

b2b revenue account of the ledger

b2bBankAccountAmazonPay
string <= 80 characters

b2b bank account for Amazon Pay of the ledger

b2bBankAccountApplePay
string <= 80 characters

b2b bank account for Apple Pay of the ledger

b2bBankAccountBilling
string <= 80 characters

b2b bank account for billing of the ledger

b2bBankAccountCreditCard
string <= 80 characters

b2b bank account for credit card of the ledger

b2bBankAccountGooglePay
string <= 80 characters

b2b bank account for Google Pay of the ledger

b2bBankAccountPayPal
string <= 80 characters

b2b bank account for PayPal of the ledger

b2bBankAccountSepa
string <= 80 characters

b2b bank account for sepa of the ledger

b2bCreditLossAccount
string <= 80 characters

b2b credit loss account of the ledger

b2bSalesTax
string <= 80 characters

b2b sales tax account of the ledger

object

custom accountings of the ledger

Responses

Request samples

Content type
application/json
{
  • "ledgerId": 100001,
  • "title": "A ledger title",
  • "description": "Default ledger description",
  • "deliveryCommitmentAccount": "4400",
  • "voucherDeliveryCommitmentAccount": "4401",
  • "revenueAccount": "5000",
  • "bankAccountAmazonPay": "2804",
  • "bankAccountApplePay": "2805",
  • "bankAccountBilling": "2800",
  • "bankAccountCreditCard": "2802",
  • "bankAccountGooglePay": "2806",
  • "bankAccountPayPal": "2803",
  • "bankAccountSepa": "2801",
  • "creditLossAccount": "3670",
  • "salesTax": "4800",
  • "b2bDeliveryCommitmentAccount": "4402",
  • "b2bVoucherDeliveryCommitmentAccount": "4403",
  • "b2bRevenueAccount": "5001",
  • "b2bBankAccountAmazonPay": "2814",
  • "b2bBankAccountApplePay": "2815",
  • "b2bBankAccountBilling": "2810",
  • "b2bBankAccountCreditCard": "2812",
  • "b2bBankAccountGooglePay": "2816",
  • "b2bBankAccountPayPal": "2813",
  • "b2bBankAccountSepa": "2811",
  • "b2bCreditLossAccount": "3671",
  • "b2bSalesTax": "4801"
}

Response samples

Content type
application/json
{
  • "ledgerId": 100001,
  • "title": "A ledger title",
  • "description": "Default ledger description",
  • "deliveryCommitmentAccount": "4400",
  • "voucherDeliveryCommitmentAccount": "4401",
  • "revenueAccount": "5000",
  • "bankAccountAmazonPay": "2804",
  • "bankAccountApplePay": "2805",
  • "bankAccountBilling": "2800",
  • "bankAccountCreditCard": "2802",
  • "bankAccountGooglePay": "2806",
  • "bankAccountPayPal": "2803",
  • "bankAccountSepa": "2801",
  • "creditLossAccount": "3670",
  • "salesTax": "4800",
  • "b2bDeliveryCommitmentAccount": "4402",
  • "b2bVoucherDeliveryCommitmentAccount": "4403",
  • "b2bRevenueAccount": "5001",
  • "b2bBankAccountAmazonPay": "2814",
  • "b2bBankAccountApplePay": "2815",
  • "b2bBankAccountBilling": "2810",
  • "b2bBankAccountCreditCard": "2812",
  • "b2bBankAccountGooglePay": "2816",
  • "b2bBankAccountPayPal": "2813",
  • "b2bBankAccountSepa": "2811",
  • "b2bCreditLossAccount": "3671",
  • "b2bSalesTax": "4801"
}

Delete ledger

Delete a ledger that is identified by the passed ledger id.

Authorizations:
plenigoToken
path Parameters
ledgerId
required
integer <int64>

unique id of the ledger

Responses

Response samples

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

Search tax codes

Search all tax codes that correspond to the given search conditions.

Authorizations:
plenigoToken
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 tax code

Create a new tax code with the data provided.

Authorizations:
plenigoToken
Request Body schema: application/json
countryType
required
string
Enum: "EU" "EU_B2B" "SINGLE_COUNTRY" "WORLD"

type of the country

countries
required
Array of strings

array of country codes formatted as ISO 3166-1 alpha-2

tax
required
number <double> [ 0 .. 100 ]

tax percentage operated on this order item

analogTag
required
string <= 80 characters

tag for the analog tax code

digitalTag
required
string <= 80 characters

tag for the digital tax code

description
string <= 100 characters

description of the tax code

Responses

Request samples

Content type
application/json
{
  • "countryType": "SINGLE_COUNTRY",
  • "countries": [
    ],
  • "tax": 19,
  • "analogTag": "A1901",
  • "digitalTag": "D1901"
}

Response samples

Content type
application/json
{
  • "taxCodeId": 100001,
  • "changedDate": "2019-03-21T17:32:12Z",
  • "countryType": "SINGLE_COUNTRY",
  • "countries": [
    ],
  • "tax": 19,
  • "analogTag": "A1901",
  • "digitalTag": "D1901"
}

Get the tax code

Get tax code that is identified by the passed tax code id.

Authorizations:
plenigoToken
path Parameters
taxCodeId
required
integer <int64>

unique id of the tax code

Responses

Response samples

Content type
application/json
{
  • "taxCodeId": 100001,
  • "changedDate": "2019-03-21T17:32:12Z",
  • "countryType": "SINGLE_COUNTRY",
  • "countries": [
    ],
  • "tax": 19,
  • "analogTag": "A1901",
  • "digitalTag": "D1901"
}

Update tax code

Update a tax code that is identified by the passed tax code id with the data provided.

Authorizations:
plenigoToken
path Parameters
taxCodeId
required
integer <int64>

unique id of the tax code

Request Body schema: application/json
countryType
required
string
Enum: "EU" "EU_B2B" "SINGLE_COUNTRY" "WORLD"

type of the country

countries
required
Array of strings

array of country codes formatted as ISO 3166-1 alpha-2

tax
required
number <double> [ 0 .. 100 ]

tax percentage operated on this order item

analogTag
required
string <= 80 characters

tag for the analog tax code

digitalTag
required
string <= 80 characters

tag for the digital tax code

description
string <= 100 characters

description of the tax code

Responses

Request samples

Content type
application/json
{
  • "taxCodeId": 100001,
  • "changedDate": "2019-03-21T17:32:12Z",
  • "countryType": "SINGLE_COUNTRY",
  • "countries": [
    ],
  • "tax": 19,
  • "analogTag": "A1901",
  • "digitalTag": "D1901"
}

Response samples

Content type
application/json
{
  • "taxCodeId": 100001,
  • "changedDate": "2019-03-21T17:32:12Z",
  • "countryType": "SINGLE_COUNTRY",
  • "countries": [
    ],
  • "tax": 19,
  • "analogTag": "A1901",
  • "digitalTag": "D1901"
}

Delete tax code

Delete a tax code that is identified by the passed tax code id.

Authorizations:
plenigoToken
path Parameters
taxCodeId
required
integer <int64>

unique id of the tax code

Responses

Response samples

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

Disputes

Search disputes

Search all disputes that correspond to the given search conditions.

Authorizations:
plenigoToken
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.

customerId
string

unique id of the customer

status
string
Enum: "LOST" "NEEDS_RESPONSE" "UNDER_REVIEW" "WARNING_CLOSED" "WARNING_NEEDS_RESPONSE" "WARNING_UNDER_REVIEW" "WON"

status of the dispute

transactionId
string

unique id of the transaction

Responses

Response samples

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

Get dispute

Get dispute that is identified by the passed dispute id.

Authorizations:
plenigoToken
path Parameters
disputeId
required
string <= 32 characters

unique id of the dispute

Responses

Response samples

Content type
application/json
{
  • "disputeId": "12341243123",
  • "changedDate": "2019-03-21T17:32:12Z",
  • "customerId": 12701,
  • "amount": 12.9,
  • "currency": "EUR",
  • "paymentProvider": "PAYPAL",
  • "cancellationInvoiceId": 23457,
  • "transactionId": "2Lx7Hfn42IoFuOiogiyDBxhiBC",
  • "status": "SUCCESS",
  • "paymentMethod": "PAYPAL",
  • "paymentAction": "PAYPAL_REFERENCE_TRANSACTION",
  • "paymentStatus": "SUCCESS",
  • "statusHistory": {
    }
}

Invoices

Search invoices

Search all invoices that correspond to the given search conditions.

Authorizations:
plenigoToken
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

orderId
integer <int64>

unique id of the order

subscriptionItemId
integer <int64>

unique id of the subscription item to search for

filterByInvoiceDate
boolean

flag indicating if returned list of invoiced should be filtered by invoice date

invoiceType
string
Enum: "INVOICE" "CANCELLATION" "CANCELLATION_CORRECTION" "CORRECTION"

allows filtering by specific invoice type

Responses

Response samples

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

Get invoice

Get invoice that is identified by the passed invoice id.

Authorizations:
plenigoToken
path Parameters
invoiceId
required
integer <int64>

unique id of the invoice

Responses

Response samples

Content type
application/json
{
  • "invoiceId": 12200,
  • "changedDate": "2019-03-21T17:32:12Z",
  • "invoiceDate": "2019-03-21T17:32:12Z",
  • "accumulatedPrice": 12,
  • "currency": "EUR",
  • "paymentMethod": "CREDIT_CARD",
  • "paymentMetodId": 145,
  • "invoiceCustomerId": 100003,
  • "invoiceAddress": {
    },
  • "items": [
    ]
}

Get PDF

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

Authorizations:
plenigoToken
path Parameters
invoiceId
required
integer <int64>

unique id of the invoice

Responses

Response samples

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

Cancel invoice

Cancel an invoice - only invoices of type INVOICE can be cancelled.

Authorizations:
plenigoToken
path Parameters
invoiceId
required
integer <int64>

unique id of the invoice

query Parameters
suppressCustomerMail
boolean

suppress sending mail with cancellation invoice to customer

suppressRefund
boolean

suppress refund the invoice amount to customer

Responses

Response samples

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

Invoice payment failed

Handle invoice payment failed for an invoice paid via billing - this must be triggered by the system responsible for invoice handling.

Authorizations:
plenigoToken
path Parameters
invoiceId
required
integer <int64>

unique id of the invoice

Responses

Response samples

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

Invoice payment status change

Change payment status of an invoice that is paid via billing - this must be triggered by the system responsible for invoice handling.

Authorizations:
plenigoToken
path Parameters
invoiceId
required
integer <int64>

unique id of the invoice

Request Body schema: application/json
status
required
string
Enum: "PAID" "NOT_PAID"

payment status of the invoice

Responses

Request samples

Content type
application/json
{
  • "status": "PAID"
}

Response samples

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

Get xml

Retrieve xml formatted invoice file for a given invoice id.

Authorizations:
plenigoToken
path Parameters
invoiceId
required
integer <int64>

unique id of the invoice

Responses

Response samples

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

Refunds

Search refunds

Search all refunds that correspond to the given search conditions.

Authorizations:
plenigoToken
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.

customerId
string

unique id of the customer

status
string
Enum: "CLOSED" "IGNORED" "OPEN" "PROCESSING" "REJECTED"

status of the refund

Responses

Response samples

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

Get refund

Get refund that is identified by the passed refund id.

Authorizations:
plenigoToken
path Parameters
refundId
required
string <= 32 characters

unique id of the refund

Responses

Response samples

Content type
application/json
{
  • "refundId": "12341243123",
  • "changedDate": "2019-03-21T17:32:12Z",
  • "customerId": 12701,
  • "amount": 12.9,
  • "currency": "EUR",
  • "paymentProvider": "PAYPAL",
  • "cancellationInvoiceId": 23457,
  • "transactionId": "2Lx7Hfn42IoFuOiogiyDBxhiBC",
  • "status": "SUCCESS",
  • "paymentMethod": "PAYPAL",
  • "paymentAction": "PAYPAL_REFERENCE_TRANSACTION",
  • "paymentStatus": "SUCCESS",
  • "statusHistory": {
    }
}

Update refund status

Update the refund

Authorizations:
plenigoToken
path Parameters
refundId
required
string <= 32 characters

unique id of the refund

Request Body schema: application/json
status
required
string
Enum: "CLOSED" "IGNORED" "OPEN" "PROCESSING" "REJECTED"

status of the refund

reason
string <= 500 characters

reason for status change

Responses

Request samples

Content type
application/json
{
  • "status": "CLOSED",
  • "reason": "string"
}

Response samples

Content type
application/json
{
  • "refundId": "12341243123",
  • "changedDate": "2019-03-21T17:32:12Z",
  • "customerId": 12701,
  • "amount": 12.9,
  • "currency": "EUR",
  • "paymentProvider": "PAYPAL",
  • "cancellationInvoiceId": 23457,
  • "transactionId": "2Lx7Hfn42IoFuOiogiyDBxhiBC",
  • "status": "SUCCESS",
  • "paymentMethod": "PAYPAL",
  • "paymentAction": "PAYPAL_REFERENCE_TRANSACTION",
  • "paymentStatus": "SUCCESS",
  • "statusHistory": {
    }
}

Transactions

Search transactions

Search all transactions that correspond to the given search conditions.

Authorizations:
plenigoToken
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

plenigoTransactionId
string

plenigo transaction id

pspTransactionId
string

PSP transaction id

Responses

Response samples

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

Get transaction

Get transaction that is identified by the passed transaction id.

Authorizations:
plenigoToken
path Parameters
transactionId
required
string <= 32 characters

unique id of the transaction

Responses

Response samples

Content type
application/json
{
  • "transactionId": "12341243123",
  • "plenigoTransactionId": "1TCZCSdg0lFEGGG3JPbZODkZKG0",
  • "sortKey": 20190321713212125000,
  • "changedDate": "2019-03-21T17:32:12Z",
  • "paymentProvider": "PAYPAL",
  • "paymentMethod": "PAYPAL",
  • "paymentAction": "PAYPAL_REFERENCE_TRANSACTION",
  • "paymentStatus": "SUCCESS",
  • "customerId": 12701,
  • "amount": 12.9,
  • "currency": "EUR"
}

Order Imports

Order import

Import the given orders into the system.

Authorizations:
plenigoToken
Request Body schema: application/json
purchase
boolean

flag indicating if import should be handled as a purchase

suppressMail
boolean

flag indicating if the sending of mails should be suppressed

Array of objects (OrderImport)

Responses

Request samples

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

Response samples

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

Search order import log entries

Search all order import log entries that correspond to the given search conditions. Import logs are only kept for 7 days.

Authorizations:
plenigoToken
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

externalSystemId
string

external system id of the order

plenigoOfferId
string

plenigo offer id of the order

success
boolean

flag indicating if only order import logs with the given success flag should be returned

Responses

Response samples

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

Get import

Get order import log entry that is identified by the passed order import log entry id.

Authorizations:
plenigoToken
path Parameters
orderImportLogEntryId
required
integer <int64>

unique id of the order import log entry

Responses

Response samples

Content type
application/json
{
  • "orderImportLogEntryId": 1230001,
  • "changedDate": "2019-01-01T07:53:23.450961Z",
  • "externalSystemId": "83432341",
  • "plenigoOfferId": "O_MZA1E7173120881551",
  • "success": false,
  • "orderId": 0,
  • "errorReason": "Order could not be imported.",
  • "errorDetail": "Payment method is required."
}

Backend User Session

Create a merchant user transfer token

Creates a transfer token for a merchant user.

Authorizations:
plenigoToken
Request Body schema: application/json
apiAccessKey
string <= 5000 characters

api access key of the merchant user to create transfer token for

Responses

Request samples

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

Response samples

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

Checkout

Voucher purchase

Executes a purchase for the product represented by the provided voucher code. Only products that are completely free and have no follow up periods that must be paid can be bought that way.

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

unique id of the customer the checkout is for

customerSession
string <= 10000 characters

active customer session - if a customer id is provided the customer id overrules the session

invoiceAddressId
integer <int64>

unique id of the invoice address to use

deliveryAddressId
integer <int64>

unique id of the delivery address to use

customerIpAddress
required
string <= 45 characters

ip address of the customer

object (AdditionalOrderData)
voucherCode
required
string <= 20 characters

voucher code to use

overwrittenProductId
string <= 20 characters

add a custom product id during the voucher checkout - this is only allowed for a single offer with one single purchase in it

Responses

Request samples

Content type
application/json
{
  • "customerId": "10003",
  • "customerIpAddress": "198.51.100.42",
  • "voucherCode": "1234-5678-1234"
}

Response samples

Content type
application/json
{
  • "orderId": 0
}

Order free product

Purchases a free product for a given customer. The product must be free of charge and if it is a subscription all the steps must be free of charge.

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

unique id of the customer the checkout is for

customerSession
string <= 10000 characters

active customer session - if a customer id is provided the customer id overrules the session

invoiceAddressId
integer <int64>

unique id of the invoice address to use

deliveryAddressId
integer <int64>

unique id of the delivery address to use

customerIpAddress
required
string <= 45 characters

ip address of the customer

object (AdditionalOrderData)
required
object (CheckoutOffer)

Responses

Request samples

Content type
application/json
{
  • "customerId": "10003",
  • "customerIpAddress": "198.51.100.42",
  • "offer": {
    }
}

Response samples

Content type
application/json
{
  • "orderId": 0
}

Prepare purchase

Prepares everything for a purchase that a customer is supposed to do. The purchase order id returned is only valid a limited time so this method should be called in time before the customer is sent to the checkout.

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

unique id of the customer the checkout is for

customerSession
string <= 10000 characters

active customer session - if a customer id is provided the customer id overrules the session

invoiceAddressId
integer <int64>

unique id of the invoice address to use

deliveryAddressId
integer <int64>

unique id of the delivery address to use

customerIpAddress
required
string <= 45 characters

ip address of the customer

showNetPrices
boolean

flag indicating if net prices should be shown during checkout

paymentOnly
boolean

flag indicating that the checkout should only show payment information

forcePaymentMethod
string
Enum: "AMAZON_PAY" "APPLE_PAY" "BANK_ACCOUNT" "BILLING" "CREDIT_CARD" "GOOGLE_PAY" "IDEAL" "PAYPAL" "POSTFINANCE" "SOFORT" "TWINT" "ZERO"

force checkout to use a specific payment method

basketId
string <= 40 characters

unique id of the plenigo basket

allowMultiplePurchases
boolean

flag indicating if product can be bought multiple times - a user will be able to pay the same product twice

startWithVoucherInput
boolean

flag indicating if checkout process should start with a voucher input field - this field is only a hint for the visual representation and if you don't use the plenigo iFrame checkout the logic must be implemented on your side

hideVoucherInput
boolean

flag indicating if checkout process should hide the voucher input field - this field is only a hint for the visual representation and if you don't use the plenigo iFrame checkout the logic must be implemented on your side

allowedPaymentMethods
Array of strings
Items Enum: "AMAZON_PAY" "APPLE_PAY" "BANK_ACCOUNT" "BILLING" "CREDIT_CARD" "GOOGLE_PAY" "IDEAL" "PAYPAL" "POSTFINANCE" "SOFORT" "TWINT" "ZERO"

possibility for additional restrictions of payment methods - only payment methods provided here and configured in the backend are allowed during checkout

language
string <= 2 characters

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

debugMode
boolean

flag indicating if debug information should be shown during purchase process

subscriptionStartDate
string or null <date-time>

optional start date of subscriptions with date notation as defined for example, 2017-07-21

object (CheckoutAddressSettings)

additional address settings

giftOption
string
Enum: "FORCE_GIFT_OPTION" "HIDE_GIFT_OPTION" "SHOW_GIFT_OPTION" "PRESELECT_GIFT_OPTION"

flag that controls if the checkout should be run as a gift checkout, should show a gift checkout box or hide it - the default value is HIDE_GIFT_OPTION

object (AdditionalOrderData)

additional data associated with this order

voucherCode
string

voucher code - if voucher code is provided no items must be provided

Array of objects (CheckoutOffer)

offers that should be sold via checkout

Array of objects (ConnectedOfferRequest)

connected offers that should be sold via checkout

Responses

Request samples

Content type
application/json
Example
{
  • "customerIpAddress": "198.51.100.42",
  • "items": [
    ]
}

Response samples

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

Login

Verify login

This functionality verifies the log in data of a customer and executes the log in. The caller must decide if a customer name or email address is provided for login. If both are provided only the email address will be used.

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

username of the customer

email
string <= 100 characters

email of the customer

password
required
string <= 100 characters

password of the customer

os
string <= 100 characters

operating system session was created on

browser
string <= 200 characters

browser session was created in

source
string <= 200 characters

source domain or app name

sourceUrl
string <= 2000 characters

source url

ipAddress
string <= 45 characters

ip address

country
string <= 2 characters

country code formatted as ISO 3166-1 alpha-2

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "email": "string",
  • "password": "string",
  • "os": "string",
  • "browser": "string",
  • "source": "string",
  • "sourceUrl": "string",
  • "ipAddress": "string",
  • "country": "st"
}

Response samples

Content type
application/json
Example
{
  • "token": "0ujsszwN8NRY24YaXiTIE2VWDTS",
  • "companyId": "aHgTmlZgnSQ6LpzkRGvK",
  • "nextStep": "TWO_FACTOR"
}

Verify two factor

This functionality validates the two factor token of a customer.

Authorizations:
plenigoToken
Request Body schema: application/json
twoFactorToken
required
string <= 6 characters

two factor token to verify login

token
required
string

The token to validate the step.

os
string <= 100 characters

operating system session was created on

browser
string <= 200 characters

browser session was created in

source
string <= 200 characters

source domain or app name

sourceUrl
string <= 2000 characters

source url

ipAddress
string <= 45 characters

ip address

country
string <= 2 characters

country code formatted as ISO 3166-1 alpha-2

Responses

Request samples

Content type
application/json
{
  • "twoFactorToken": "string",
  • "token": "string",
  • "os": "string",
  • "browser": "string",
  • "source": "string",
  • "sourceUrl": "string",
  • "ipAddress": "string",
  • "country": "st"
}

Response samples

Content type
application/json
Example
{
  • "token": "0ujsszwN8NRY24YaXiTIE2VWDTS",
  • "companyId": "aHgTmlZgnSQ6LpzkRGvK",
  • "nextStep": "RESET_PASSWORD"
}

Verify password reset

This functionality validates the password reset of a customer.

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

new password of the customer

token
required
string

The token to validate the step.

os
string <= 100 characters

operating system session was created on

browser
string <= 200 characters

browser session was created in

source
string <= 200 characters

source domain or app name

sourceUrl
string <= 2000 characters

source url

ipAddress
string <= 45 characters

ip address

country
string <= 2 characters

country code formatted as ISO 3166-1 alpha-2

Responses

Request samples

Content type
application/json
{
  • "password": "string",
  • "token": "string",
  • "os": "string",
  • "browser": "string",
  • "source": "string",
  • "sourceUrl": "string",
  • "ipAddress": "string",
  • "country": "st"
}

Response samples

Content type
application/json
Example
{
  • "token": "0ujsszwN8NRY24YaXiTIE2VWDTS",
  • "companyId": "aHgTmlZgnSQ6LpzkRGvK",
  • "nextStep": "ADDITIONAL_DATA",
  • "additionalInformation": {
    }
}

Update additional data

Add missing customer data like username, first name and last name to the customer if requested by process. Only data that are actively requested can be set here.

Authorizations:
plenigoToken
Request Body schema: application/json
One of
companyId
required
string <= 20 characters

Id of the company the process is running for.

nextStep
string
Enum: "ADDITIONAL_DATA" "RESET_PASSWORD" "TWO_FACTOR"

The next step the process should go to.

twoFactorBarCodeImage
string

base64 encoded bar code image to show to the user if step is two factor verification

verificationToken
string

verification token sent to user via email if next step requires a verification

additionalInformation
object

additional information depending on the next step

token
required
string

The token to validate the step.

Responses

Request samples

Content type
application/json
Example
{
  • "stepToken": "0ujsszwN8NRY24YaXiTIE2VWDTS",
  • "username": "user1",
  • "firstName": "John",
  • "lastName": "Doe",
  • "browser": "Firefox",
  • "os": "Windows 10",
  • "source": "Web",
  • "sourceUrl": "https://www.example.com",
  • "ipAddress": "127.0.0.1",
  • "country": "DE"
}

Response samples

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

Remove active sessions

Removes one or all active sessions of a customer. If a session id is provided the specific session will be removed otherwise all active sessions will be removed.

Authorizations:
plenigoToken
path Parameters
removalToken
required
string <= 40 characters

token for the temporary removal session

query Parameters
sessionId
string <= 40 characters

id of the session

Responses

Response samples

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

Password Forgotten

Send token

This functionality sends the password forgotten token to reset password.

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

email of the customer - required if username is not provided

username
string <= 100 characters

username of the customer - required if email is not provided

language
required
string <= 2 characters

language of the customer

verificationUrl
string <= 500 characters

url to verify registration - if provided two parameters are added to the url (token and step) and it is passed to the registration mail. This way the application that embeds the plenigo registration from can handle a user verification via link instead of a token process.

os
string <= 100 characters

operating system session was created on

browser
string <= 200 characters

browser session was created in

source
string <= 200 characters

source domain or app name

sourceUrl
string <= 2000 characters

source url

ipAddress
string <= 45 characters

ip address

country
string <= 2 characters

country code formatted as ISO 3166-1 alpha-2

Responses

Request samples

Content type
application/json
Example
{
  • "email": "test@example.com",
  • "language": "de",
  • "browser": "Firefox",
  • "os": "Windows 10",
  • "source": "Web",
  • "sourceUrl": "https://www.example.com",
  • "ipAddress": "127.0.0.1",
  • "country": "DE"
}

Response samples

Content type
application/json
{
  • "token": "0ujsszwN8NRY24YaXiTIE2VWDTS",
  • "companyId": "aHgTmlZgnSQ6LpzkRGvK",
  • "nextStep": "VERIFY_TOKEN",
  • "verificationToken": "123456"
}

Resend token

This functionality resend the password forgotten token to reset password.

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

The token to validate the step.

os
string <= 100 characters

operating system session was created on

browser
string <= 200 characters

browser session was created in

source
string <= 200 characters

source domain or app name

sourceUrl
string <= 2000 characters

source url

ipAddress
string <= 45 characters

ip address

country
string <= 2 characters

country code formatted as ISO 3166-1 alpha-2

Responses

Request samples

Content type
application/json
{
  • "token": "0ujsszwN8NRY24YaXiTIE2VWDTS",
  • "browser": "Firefox",
  • "os": "Windows 10",
  • "source": "Web",
  • "sourceUrl": "https://www.example.com",
  • "ipAddress": "127.0.0.1",
  • "country": "DE"
}

Response samples

Content type
application/json
{
  • "token": "0ujsszwN8NRY24YaXiTIE2VWDTS",
  • "companyId": "aHgTmlZgnSQ6LpzkRGvK",
  • "nextStep": "VERIFY_TOKEN",
  • "verificationToken": "123456"
}

Token verification

This functionality verifies the token to reset password.

Authorizations:
plenigoToken
Request Body schema: application/json
verificationToken
required
string <= 6 characters

email verification token

token
required
string

The token to validate the step.

Responses

Request samples

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

Response samples

Content type
application/json
Example
{
  • "token": "0ujsszwN8NRY24YaXiTIE2VWDTS",
  • "companyId": "aHgTmlZgnSQ6LpzkRGvK",
  • "nextStep": "RESET_PASSWORD"
}

Reset password

This functionality resets the password of the customer.

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

new password of the customer

token
required
string

The token to validate the step.

os
string <= 100 characters

operating system session was created on

browser
string <= 200 characters

browser session was created in

source
string <= 200 characters

source domain or app name

sourceUrl
string <= 2000 characters

source url

ipAddress
string <= 45 characters

ip address

country
string <= 2 characters

country code formatted as ISO 3166-1 alpha-2

Responses

Request samples

Content type
application/json
{
  • "password": "string",
  • "token": "string",
  • "os": "string",
  • "browser": "string",
  • "source": "string",
  • "sourceUrl": "string",
  • "ipAddress": "string",
  • "country": "st"
}

Response samples

Content type
application/json
{
  • "token": "0ujsszwN8NRY24YaXiTIE2VWDTS",
  • "companyId": "aHgTmlZgnSQ6LpzkRGvK",
  • "nextStep": "ADDITIONAL_DATA",
  • "additionalInformation": {
    }
}

Verify two factor token

This functionality verifies the two factor of the customer.

Authorizations:
plenigoToken
Request Body schema: application/json
twoFactorToken
required
string <= 6 characters

two factor token to verify the customer

token
required
string

The token to validate the step.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "token": "0ujsszwN8NRY24YaXiTIE2VWDTS",
  • "companyId": "aHgTmlZgnSQ6LpzkRGvK",
  • "nextStep": "VERIFY_TOKEN",
  • "verificationToken": "123456"
}

Update additional data

Add missing customer data like username, first name and last name to the customer if requested by process. Only data that are actively requested can be set here.

Authorizations:
plenigoToken
Request Body schema: application/json
object (StepToken)
username
string <= 100 characters

username of the new customer

firstName
string <= 100 characters

first name of the new customer

lastName
string <= 100 characters

last name of the new customer

object (LoggingData)

Responses

Request samples

Content type
application/json
{
  • "stepToken": "0ujsszwN8NRY24YaXiTIE2VWDTS",
  • "username": "user1",
  • "firstName": "John",
  • "lastName": "Doe",
  • "browser": "Firefox",
  • "os": "Windows 10",
  • "source": "Web",
  • "sourceUrl": "https://www.example.com",
  • "ipAddress": "127.0.0.1",
  • "country": "DE"
}

Response samples

Content type
application/json
{
  • "activeSessions": {
    },
  • "removalToken": "2ujsszwN8NRY24YaXiTIE2VWDTE"
}

Remove active sessions

Removes one or all active sessions of a customer. If a session id is provided the specific session will be removed otherwise all active sessions will be removed.

Authorizations:
plenigoToken
path Parameters
removalToken
required
string <= 40 characters

token for the temporary removal session

query Parameters
sessionId
string <= 40 characters

id of the session

Responses

Response samples

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

Process Settings

Get process settings

Get settings for configuring the SSO and checkout part.

Authorizations:
plenigoToken
query Parameters
language
string = 2 characters

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

plenigoCheckoutDesignId
string

plenigo checkout design id

Responses

Response samples

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

Registration

Start registration

This functionality starts the registration process for a new customer. If address data will be provided a new invoice address will be created - country is mandatory for an address. If only the first and the last name are provided the first and last name of the customer will be filled.

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

username of the new customer

email
required
string <= 100 characters

email of the new customer

password
required
string <= 100 characters

password of the new customer

language
required
string <= 2 characters

language of the new customer

mobileNumber
string <= 100 characters

mobile number of the new customer

ipAddress
string <= 100 characters

IP address of the new customer

customerNotification
boolean

flag indicating if a mail or SMS should be send to the customer.

firstName
string <= 100 characters

first name of the new customer

lastName
string <= 100 characters

last name of the new customer

verificationUrl
string <= 500 characters

url to verify registration - if provided two parameters are added to the url (token and step) and it is passed to the registration mail. This way the application that embeds the plenigo registration from can handle a user verification via link instead of a token process.

object (AddressChange)
object (AddressChange)

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "email": "string",
  • "password": "string",
  • "language": "st",
  • "mobileNumber": "string",
  • "ipAddress": "string",
  • "customerNotification": true,
  • "firstName": "string",
  • "lastName": "string",
  • "verificationUrl": "string",
  • "invoiceAddress": {
    },
  • "deliveryAddress": {
    }
}

Response samples

Content type
application/json
Example
{
  • "token": "0ujsszwN8NRY24YaXiTIE2VWDTS",
  • "companyId": "aHgTmlZgnSQ6LpzkRGvK",
  • "nextStep": "EMAIL",
  • "verificationToken": "123456"
}

Validate registration token

This functionality finishes the registration process by providing a token.

Authorizations:
plenigoToken
Request Body schema: application/json
verificationToken
required
string <= 6 characters

token to verify registration

token
required
string

The token to validate the step.

os
string <= 100 characters

operating system session was created on

browser
string <= 200 characters

browser session was created in

source
string <= 200 characters

source domain or app name

sourceUrl
string <= 2000 characters

source url

ipAddress
string <= 45 characters

ip address

country
string <= 2 characters

country code formatted as ISO 3166-1 alpha-2

Responses

Request samples

Content type
application/json
{
  • "verificationToken": "string",
  • "token": "string",
  • "os": "string",
  • "browser": "string",
  • "source": "string",
  • "sourceUrl": "string",
  • "ipAddress": "string",
  • "country": "st"
}

Response samples

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

Resend verification token

This functionality resend the registration process token.

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

The token to validate the step.

Responses

Request samples

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

Response samples

Content type
application/json
Example
{
  • "token": "0ujsszwN8NRY24YaXiTIE2VWDTS",
  • "companyId": "aHgTmlZgnSQ6LpzkRGvK",
  • "nextStep": "EMAIL",
  • "verificationToken": "123456"
}

Start registration identifier

This functionality starts the registration process for an existing customer with registration identifier.

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

username of the new customer

email
string <= 100 characters

email of the new customer

password
string <= 100 characters

password of the new customer

language
string <= 2 characters

language of the new customer

mobileNumber
string <= 100 characters

mobile number of the new customer

ipAddress
string <= 100 characters

IP address of the new customer

customerNotification
boolean

flag indicating if a mail or SMS should be send to the customer

firstName
string <= 100 characters

first name of the new customer

lastName
string <= 100 characters

last name of the new customer

object (AddressChange)
object (AddressChange)
customerId
string^[0-9]{1,18}$

customer id of the existing customer

subscriptionId
integer <int64>

subscription id of the existing subscription - if also a customer id is provided the customer id must match the invoice customer id of the subscription

postcode
string <= 100 characters

postcode of a customer's address - if multiple address information are requested all must belong to one address

street
string <= 100 characters

street of a customer's address - if multiple address information are requested all must belong to one address

streetNumber
string <= 100 characters

street number of a customer's address - if multiple address information are requested all must belong to one address

city
string <= 100 characters

city of a customer's address - if multiple address information are requested all must belong to one address

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "email": "string",
  • "password": "string",
  • "language": "st",
  • "mobileNumber": "string",
  • "ipAddress": "string",
  • "customerNotification": true,
  • "firstName": "string",
  • "lastName": "string",
  • "invoiceAddress": {
    },
  • "deliveryAddress": {
    },
  • "customerId": "string",
  • "subscriptionId": 0,
  • "postcode": "string",
  • "street": "string",
  • "streetNumber": "string",
  • "city": "string"
}

Response samples

Content type
application/json
Example
{
  • "token": "0ujsszwN8NRY24YaXiTIE2VWDTS",
  • "companyId": "aHgTmlZgnSQ6LpzkRGvK",
  • "nextStep": "EMAIL",
  • "verificationToken": "123456"
}

Validate registration identifier token

This functionality finishes the registration process with registration identifier by providing a token.

Authorizations:
plenigoToken
Request Body schema: application/json
verificationToken
required
string <= 6 characters

token to verify registration

token
required
string

The token to validate the step.

os
string <= 100 characters

operating system session was created on

browser
string <= 200 characters

browser session was created in

source
string <= 200 characters

source domain or app name

sourceUrl
string <= 2000 characters

source url

ipAddress
string <= 45 characters

ip address

country
string <= 2 characters

country code formatted as ISO 3166-1 alpha-2

Responses

Request samples

Content type
application/json
{
  • "verificationToken": "string",
  • "token": "string",
  • "os": "string",
  • "browser": "string",
  • "source": "string",
  • "sourceUrl": "string",
  • "ipAddress": "string",
  • "country": "st"
}

Response samples

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

Resend registration identifier token

This functionality resend the registration process registration identifier token.

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

The token to validate the step.

Responses

Request samples

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

Response samples

Content type
application/json
Example
{
  • "token": "0ujsszwN8NRY24YaXiTIE2VWDTS",
  • "companyId": "aHgTmlZgnSQ6LpzkRGvK",
  • "nextStep": "EMAIL",
  • "verificationToken": "123456"
}

Sso Provider Login

Verify sso login

This functionality verifies the log in data of a customer over a sso provider and executes the log in. The caller must decide if a customer name or email address is provided for login. If both are provided only the email address will be used.

Authorizations:
plenigoToken
Request Body schema: application/json
One of
language
string <= 2 characters

language of the customer

ssoProvider
required
string
Value: "GOOGLE"

sso provider name

required
object (GoogleSsoAuthentication)
os
string <= 100 characters

operating system session was created on

browser
string <= 200 characters

browser session was created in

source
string <= 200 characters

source domain or app name

sourceUrl
string <= 2000 characters

source url

ipAddress
string <= 45 characters

ip address

country
string <= 2 characters

country code formatted as ISO 3166-1 alpha-2

Responses

Request samples

Content type
application/json
{
  • "language": "st",
  • "ssoProvider": "GOOGLE",
  • "authenticationData": {
    },
  • "os": "string",
  • "browser": "string",
  • "source": "string",
  • "sourceUrl": "string",
  • "ipAddress": "string",
  • "country": "st"
}

Response samples

Content type
application/json
Example
{
  • "token": "0ujsszwN8NRY24YaXiTIE2VWDTS",
  • "companyId": "aHgTmlZgnSQ6LpzkRGvK",
  • "nextStep": "TWO_FACTOR"
}

Age Rules

Search age rules

Search all age rules that correspond to the given search conditions.

Authorizations:
plenigoToken
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 age rule

Get age rule that is identified by the passed age rule id.

Authorizations:
plenigoToken
path Parameters
ageRuleId
required
integer <int64>

unique id of the age rule

Responses

Response samples

Content type
application/json
{
  • "ageRuleId": 0,
  • "internalTitle": "string",
  • "description": "string",
  • "relationalOperator": "ABOVE",
  • "age": 1,
  • "protectedPlenigoOfferId": "string",
  • "followUpPlenigoOfferId": "string",
  • "replacementPlenigoOfferId": "string",
  • "stopOnFail": true,
  • "translations": [
    ],
  • "createdDate": "2019-08-24T14:15:22Z",
  • "changedDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "createdByType": "API",
  • "changedBy": "string",
  • "changedByType": "API"
}

Bonuses

Search bonuses

Search all bonuses that correspond to the given search conditions.

Authorizations:
plenigoToken
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.

plenigoBonusId
string

plenigo bonus id of the offer

Responses

Response samples

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

Search archived bonuses

Search all archived bonuses that correspond to the given search conditions.

Authorizations:
plenigoToken
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 bonus

Get bonus that is identified by the passed bonus id.

Authorizations:
plenigoToken
path Parameters
bonusId
required
integer <int64>

unique id of the bonus

Responses

Response samples

Content type
application/json
{
  • "accessRightId": 223001,
  • "archived": true,
  • "availability": "AVAILABLE",
  • "taxType": "ADVERTISEMENT",
  • "bonusId": 123400,
  • "costCenterId": 123001,
  • "deliveryAddressMandatory": true,
  • "deliveryAmount": 1,
  • "deliveryCondition": "AFTER_PAYMENT",
  • "description": "The cheapest teacup we have in stock.",
  • "internalTitle": "Teacup",
  • "invoiceAddressMandatory": true,
  • "plenigoBonusId": "BO_12345678901234567",
  • "priceIssueId": 323001,
  • "shippingCostPriceIssueId": 323002,
  • "receiver": "PAYER",
  • "translations": [
    ],
  • "createdDate": "2019-08-24T14:15:22Z",
  • "changedDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "createdByType": "API",
  • "changedBy": "string",
  • "changedByType": "API"
}

Cross Sellings

Search cross sellings

Search all cross sellings that correspond to the given search conditions.

Authorizations:
plenigoToken
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 cross selling

Get cross selling that is identified by the passed cross selling id.

Authorizations:
plenigoToken
path Parameters
crossSellingId
required
integer <int64>

unique id of the cross selling

Responses

Response samples

Content type
application/json
{
  • "crossSellingId": 18001,
  • "internalTitle": "Update to best product",
  • "description": "We offer our customers the best product.",
  • "accessStart": "NOW",
  • "optional": false,
  • "sourceProductTags": [
    ],
  • "targetProductTags": [
    ],
  • "translations": [
    ]
}

Delivery Lists

Search delivery lists

Search all delivery lists that correspond to the given search conditions.

Authorizations:
plenigoToken
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 delivery list

Get delivery list that is identified by the passed delivery list id.

Authorizations:
plenigoToken
path Parameters
deliveryListId
required
integer <int64>

unique id of the delivery list

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
{
  • "deliveryListId": 37000,
  • "title": "Cool magazine",
  • "type": "ANALOG",
  • "description": "The best magazine ever!",
  • "fileNamePart": "cool_magazine.csv",
  • "checkReminderReceivers": "test@example.com",
  • "checkDateIntervalWeeks": 32,
  • "enabled": true
}

Get delivery list dates

Get delivery list dates that belong to the delivery list identified by the passed delivery list id.

Authorizations:
plenigoToken
path Parameters
deliveryListId
required
integer <int64>

unique id of the delivery list

query Parameters
ignorePast
boolean

flag indicating if past delivery dates should be ignored

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 delivery list dates

Get delivery list dates that belong to the delivery list identified by the passed delivery list id.

Authorizations:
plenigoToken
path Parameters
deliveryListId
required
integer <int64>

unique id of the delivery list

sourceCompanyId
required
string <= 20 characters

source company id

sharedOfferId
required
integer <int64>

unique id of the sharedOffer

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": [
    ]
}

Update delivery date status

Update the status of a delivery list date.

Authorizations:
plenigoToken
path Parameters
deliveryListId
required
integer <int64>

unique id of the delivery list

deliveryListDateId
required
integer <int64>

unique id of the delivery list date

Request Body schema: application/json
status
required
string
Enum: "AVAILABLE" "SOLD_OUT"

status of a delivery list date

Responses

Request samples

Content type
application/json
{
  • "status": "AVAILABLE"
}

Response samples

Content type
application/json
{
  • "deliveryListCreatedAt": "2019-08-24T14:15:22Z",
  • "redeliveryListCreatedAt": "2019-08-24T14:15:22Z",
  • "deliveryListDateId": 0,
  • "title": "string",
  • "costCenter": "string",
  • "purchaseNumber": "string",
  • "publishingDate": "2019-08-24T14:15:22Z",
  • "deliveryDate": "2019-08-24T14:15:22Z",
  • "redeliveryDate": "2019-08-24T14:15:22Z",
  • "additionalData": {
    },
  • "translations": [
    ],
  • "createdDate": "2019-08-24T14:15:22Z",
  • "changedDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "createdByType": "API",
  • "changedBy": "string",
  • "changedByType": "API"
}

IVW Rules

Search ivw rules

Search all ivw rules that correspond to the given search conditions.

Authorizations:
plenigoToken
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 ivw rule

Get ivw rule that is identified by the passed ivw rule id.

Authorizations:
plenigoToken
path Parameters
ivwRuleId
required
integer <int64>

unique id of the ivw rule

Responses

Response samples

Content type
application/json
{
  • "ivwRuleId": 17001,
  • "title": "A new ivw rule",
  • "internalTitle": "A new ivw rule",
  • "description": "Ivw rule description",
  • "ivwType": "ABONNEMENT",
  • "ivwPriceType": "PERIOD_BASED",
  • "fullPriceDivergenceUp": 10,
  • "fullPriceDivergenceDown": 5,
  • "fullPriceIssueId": 12001,
  • "otherSalePriceDivergenceDown": 5,
  • "otherSalePriceIssueId": 12001
}

Misuse Rules

Search misuse rules

Search all misuse rules that correspond to the given search conditions.

Authorizations:
plenigoToken
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 misuse rule

Get misuse rule that is identified by the passed misuse rule id.

Authorizations:
plenigoToken
path Parameters
misuseRuleId
required
integer <int64>

unique id of the misuse rule

Responses

Response samples

Content type
application/json
{
  • "misuseRuleId": 17001,
  • "internalTitle": "A new misuse rule",
  • "description": "Misuse rule",
  • "duration": 12,
  • "durationTimespan": "MONTH",
  • "plenigoOfferId": "O_123456789123456789",
  • "translations": [
    ]
}

Offers

Search offers

Search all offers that correspond to the given search conditions.

Authorizations:
plenigoToken
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

plenigoOfferId
string

plenigo offer id of the offer

leafId
integer <int64>

unique id of the sort tree leaf

Responses

Response samples

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

Search archived offers

Search all archived offers that correspond to the given search conditions.

Authorizations:
plenigoToken
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

plenigoOfferId
string

plenigo offer id of the offer

leafId
integer <int64>

unique id of the sort tree leaf

Responses

Response samples

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

Get offer

Get offer that is identified by the passed offer id.

Authorizations:
plenigoToken
path Parameters
offerId
required
integer <int64>

unique id of the offer

Responses

Response samples

Content type
application/json
{
  • "offerId": 50001,
  • "plenigoOfferId": "O_123456789123456789",
  • "internalTitle": "A new offer",
  • "pauseAble": false,
  • "invoiceAddressMandatory": false,
  • "deliveryAddressMandatory": false,
  • "multiplePurchases": false,
  • "misuseRuleId": 17001,
  • "archived": false,
  • "allowedPaymentMethods": [
    ],
  • "connectedCompanySettings": [
    ],
  • "translations": [
    ],
  • "products": [
    ],
  • "productGroups": [
    ]
}

Get shared offers

Get offers shared with the company

Authorizations:
plenigoToken

Responses

Response samples

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

Get shared offer

Get specific offer which is shared with the company

Authorizations:
plenigoToken
path Parameters
sourceCompanyId
required
string <= 20 characters

source company id

sharedOfferId
required
integer <int64>

unique id of the sharedOffer

Responses

Response samples

Content type
application/json
{
  • "offerId": 50001,
  • "plenigoOfferId": "O_123456789123456789",
  • "internalTitle": "A new offer",
  • "pauseAble": false,
  • "invoiceAddressMandatory": false,
  • "deliveryAddressMandatory": false,
  • "multiplePurchases": false,
  • "misuseRuleId": 17001,
  • "archived": false,
  • "allowedPaymentMethods": [
    ],
  • "connectedCompanySettings": [
    ],
  • "translations": [
    ],
  • "products": [
    ],
  • "productGroups": [
    ]
}

Price Country Segments

Search price country segments

Search all price country segments that correspond to the given search conditions.

Authorizations:
plenigoToken
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
{
  • "priceCountrySegmentId": 12001,
  • "title": "Europa light",
  • "priority": 2,
  • "description": "Europe with only a few countries",
  • "countries": [
    ],
  • "archived": false
}

Get price country segment

Get price country segment that is identified by the passed price country segment id.

Authorizations:
plenigoToken
path Parameters
priceCountrySegmentId
required
integer <int64>

unique id of the price country segment

Responses

Response samples

Content type
application/json
{
  • "priceCountrySegmentId": 12001,
  • "title": "Europa light",
  • "priority": 2,
  • "description": "Europe with only a few countries",
  • "countries": [
    ],
  • "archived": false
}

Price Issues

Search price issues

Search all price issues that correspond to the given search conditions.

Authorizations:
plenigoToken
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 archived price issues

Search all archived price issues that correspond to the given search conditions.

Authorizations:
plenigoToken
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 price issue

Get price issue that is identified by the passed price issue id.

Authorizations:
plenigoToken
path Parameters
priceIssueId
required
integer <int64>

unique id of the price issue

Responses

Response samples

Content type
application/json
{
  • "priceIssueId": 10001,
  • "title": "Price list number one",
  • "description": "The first price list for our products",
  • "archived": false,
  • "priceSegments": [
    ]
}

Product Access Rights

Search access rights

Search all access rights that correspond to the given search conditions.

Authorizations:
plenigoToken
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 access right

Get access right that is identified by the passed access right id.

Authorizations:
plenigoToken
path Parameters
accessRightId
required
integer <int64>

unique id of the access right

Responses

Response samples

Content type
application/json
{
  • "accessRightId": 2000,
  • "title": "A new access right",
  • "uniqueId": "accessRight",
  • "description": "Access right",
  • "additionalData": {
    }
}

Product Contracts

Search product contract

Search all product contracts that correspond to the given search conditions.

Authorizations:
plenigoToken
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": [
    ]
}

Search archived product contracts

Search all archived product contracts that correspond to the given search conditions.

Authorizations:
plenigoToken
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 product contract

Get product contract that is identified by the passed product contract id.

Authorizations:
plenigoToken
path Parameters
productContractId
required
integer <int64>

unique id of the product contract

Responses

Response samples

Content type
application/json
{
  • "productContractId": 0,
  • "archived": true,
  • "createdDate": "2019-08-24T14:15:22Z",
  • "changedDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "createdByType": "API",
  • "changedBy": "string",
  • "changedByType": "API",
  • "priceIssueId": 0,
  • "title": "string",
  • "leafId": 0,
  • "description": "string",
  • "contractType": "CREDIT_BASED",
  • "productTagIds": [
    ],
  • "ivwRuleId": 0,
  • "timeBasedCondition": {
    },
  • "issueBasedCondition": {
    },
  • "creditBasedCondition": {
    }
}

Product Tags

Search product tags

Search all product tags that correspond to the given search conditions.

Authorizations:
plenigoToken
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 product tag

Get product tag that is identified by the passed product tag id.

Authorizations:
plenigoToken
path Parameters
productTagId
required
integer <int64>

unique id of the product tag

Responses

Response samples

Content type
application/json
{
  • "productTagId": 18001,
  • "name": "Action Period",
  • "category": "ANALYTICS",
  • "description": "Identifies the first action period."
}

Shopping Carts

Search shopping carts

Search all shopping carts that correspond to the given search conditions.

Authorizations:
plenigoToken
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.

plenigoShoppingCartId
string

plenigo shopping cart id of the shopping cart

Responses

Response samples

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

Search archived shoppingCarts

Search all archived shopping carts that correspond to the given search conditions.

Authorizations:
plenigoToken
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 shopping cart

Get shopping cart that is identified by the passed shopping cart id.

Authorizations:
plenigoToken
path Parameters
shoppingCartId
required
integer <int64>

unique id of the shopping cart

Responses

Response samples

Content type
application/json
{
  • "shoppingCartId": 0,
  • "plenigoShoppingCartId": "stringstringstringst",
  • "items": [
    ],
  • "itemGroups": [
    ],
  • "internalTitle": "string",
  • "translations": [
    ],
  • "hintTmId": 0,
  • "createdDate": "2019-08-24T14:15:22Z",
  • "changedDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "createdByType": "API",
  • "changedBy": "string",
  • "changedByType": "API"
}

Vouchers

Returns all vouchers

Returns all vouchers of the selected channel page, depending on query parameters

Authorizations:
plenigoToken
query Parameters
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.

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

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

voucherStatus
string
Enum: "ACTIVE" "CANCELLED" "INACTIVE" "DELETED"

status of the voucher

Responses

Response samples

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

Create voucher campaign

ASYNC Creates a new voucher campaign with the data provided. ATTENTION - this process is async.

Authorizations:
plenigoToken
query Parameters
callback
boolean

if set to true the call to this endpoint will return a promise ID and creates a new voucher request callback that contains the data provided. The callback also returns the promise ID returned by this call to be identified.

Request Body schema: application/json
campaignName
required
string <= 200 characters

name of the campaign

voucherType
required
string
Enum: "MULTI" "SINGLE"

represents the type of the vouchers of this campaign

plenigoOfferId
required
string <= 20 characters

plenigo offer id the vouchers are for

startDate
required
null or string <date>

start date of the campaign with full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

endDate
null or string <date>

end date of the campaign with full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

required
Array of objects (ChannelCreation)

Responses

Request samples

Content type
application/json
{
  • "campaignName": "API Campaign Creation",
  • "voucherType": "SINGLE",
  • "plenigoOfferId": "O_TTA1E7173120881551",
  • "startDate": "2019-12-16",
  • "endDate": "2099-12-16",
  • "channels": [
    ]
}

Response samples

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

Search campaigns

Search all campaigns that correspond to the given search conditions.

Authorizations:
plenigoToken
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

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.

voucherCode
string

voucher code to get

Responses

Response samples

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

Get campaign

Get campaign that is identified by the passed campaign id.

Authorizations:
plenigoToken
path Parameters
campaignId
required
string

unique id of the campaign

Responses

Response samples

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

Update channel

ASYNC Update channel that is identified by the passed channel id. ATTENTION - this process is async.

Authorizations:
plenigoToken
path Parameters
channelId
required
string

unique id of the channel

query Parameters
callback
boolean

if set to true the call to this endpoint will return a promise ID and creates a new voucher request callback that contains the data provided. The callback also returns the promise ID returned by this call to be identified.

Request Body schema: application/json
channelName
string <= 200 characters

name of the channel

customData
string <= 200 characters

free text field

voucherAmount
integer [ 0 .. 10000000 ]

represents the amount of vouchers to create for this channel

Responses

Request samples

Content type
application/json
{
  • "channelName": "New API Channel",
  • "customData": "New Custom data",
  • "voucherAmount": 1
}

Response samples

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

Returns channel vouchers

Returns all vouchers of the selected channel page, depending on query parameters

Authorizations:
plenigoToken
path Parameters
channelId
required
string

unique id of the channel

query Parameters
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.

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

voucherStatus
string
Enum: "ACTIVE" "CANCELLED" "INACTIVE" "DELETED"

status of the voucher

Responses

Response samples

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

Validate voucher code

Validates the voucher code provided.

Authorizations:
plenigoToken
path Parameters
voucherCode
required
string

voucher code to validate

Responses

Response samples

Content type
application/json
[
  • {
    }
]

App Stores

Search Apple purchases

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

Authorizations:
plenigoToken
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

token
string

app store token

Responses

Response samples

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

Add Apple purchase

Add an Apple app store purchase to the plenigo system and retrieve a token for further processing.

Authorizations:
plenigoToken
Request Body schema: application/json
appIdentifier
string <= 100 characters

identifier of the application as defined in the plenigo backend to retrieve the according secret

receiptData
Array of strings [ 1 .. 100 ] items [ items <= 10000 characters ]

Responses

Request samples

Content type
application/json
{
  • "appIdentifier": "string",
  • "receiptData": [
    ]
}

Response samples

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

Get Apple purchase

Get details for an Apple app store purchase.

Authorizations:
plenigoToken
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"
}

Associate Apple purchase

Associate an Apple app store purchase with a customer. Only app store purchases that include actual orders can be associated.

Authorizations:
plenigoToken
path Parameters
token
required
string

unique id of the purchase of an app store

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

id of the customer to associate purchase with

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "customerId": "string",
  • "token": "string",
  • "hasOrders": true,
  • "orders": [
    ]
}

Dissociate Apple purchase

Dissociate an Apple app store purchase from a customer.

Authorizations:
plenigoToken
path Parameters
token
required
string

unique id of the purchase of an app store

Responses

Response samples

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

Verify Apple purchase

Verify validity of Apple app store purchase.

Authorizations:
plenigoToken
path Parameters
token
required
string

unique id of the purchase of an app store

Responses

Response samples

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

Search Google Playstore purchases

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

Authorizations:
plenigoToken
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

token
string

app store token

Responses

Response samples

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

Add Google purchase

Add a Google Playstore purchase to the plenigo system and retrieve a token for further processing.

Authorizations:
plenigoToken
Request Body schema: application/json
packageName
string <= 1000 characters

package name of the application this purchase was done for (for example, 'com.some.thing').

Array of objects (GooglePlayStorePurchaseAdditionElement) [ 1 .. 100 ] items

Responses

Request samples

Content type
application/json
{
  • "packageName": "string",
  • "receiptData": [
    ]
}

Response samples

Content type
application/json
Example
{
  • "customerId": "string",
  • "token": "string",
  • "hasOrders": true,
  • "orders": [
    ]
}

Get Google Playstore purchase

Get details for a Google Playstore purchase.

Authorizations:
plenigoToken
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"
}

Associate Google purchase

Associate a Google Playstore purchase with a customer.

Authorizations:
plenigoToken
path Parameters
token
required
string

unique id of the purchase of an app store

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

id of the customer to associate purchase with

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "customerId": "string",
  • "token": "string",
  • "hasOrders": true,
  • "orders": [
    ]
}

Dissociate Google purchase

Dissociate a Google Playstore purchase from a customer.

Authorizations:
plenigoToken
path Parameters
token
required
string

unique id of the purchase of an app store

Responses

Response samples

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

Verify Google purchase

Verify validity of Google Playstore purchase.

Authorizations:
plenigoToken
path Parameters
token
required
string

unique id of the purchase of an app store

Responses

Response samples

Content type
application/json
Example
{
  • "customerId": "string",
  • "token": "string",
  • "hasOrders": true,
  • "orders": [
    ]
}

Search app store order

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

Authorizations:
plenigoToken
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:
plenigoToken
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:
plenigoToken
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:
plenigoToken
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"
}

Orders

Search orders

Search all orders that correspond to the given search conditions.

Authorizations:
plenigoToken
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

externalSystemId
string

external system id defined by third party systems

Responses

Response samples

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

Search additional data

Search all additional order data that correspond to the given search conditions.

Authorizations:
plenigoToken
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

Get order that is identified by the passed order id.

Authorizations:
plenigoToken
path Parameters
orderId
required
integer <int64>

unique id of the order

Responses

Response samples

Content type
application/json
{
  • "orderId": 12200,
  • "changedDate": "2019-03-21T17:32:12Z",
  • "status": "DONE",
  • "type": "ORDER",
  • "orderDate": "2019-03-21T17:32:12Z",
  • "accumulatedPrice": 12,
  • "currency": "EUR",
  • "purchaseOrderIndicator": "2019-03A1",
  • "paymentMethod": "PAYPAL",
  • "paymentMethodId": 100231,
  • "invoiceCustomerId": 100003,
  • "invoiceAddress": {
    },
  • "items": [
    ]
}

Get additional data

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

Authorizations:
plenigoToken
path Parameters
orderId
required
integer <int64>

unique id of the order

Responses

Response samples

Content type
application/json
{}

Get PDF

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

Authorizations:
plenigoToken
path Parameters
orderId
required
integer <int64>

unique id of the order

Responses

Response samples

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

Search purchased addons

Search all purchased addons that correspond to the given search conditions.

Authorizations:
plenigoToken
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 purchased addon

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

Authorizations:
plenigoToken
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"
}

Update purchased addon tracking data

Update the tracking data of a purchased addons.

Authorizations:
plenigoToken
path Parameters
purchasedAddonId
required
integer <int64>

unique id of the purchase addon

Request Body schema: application/json
status
required
string
Enum: "CANCELLED" "DELIVERED" "IN_DELIVERY" "OPEN" "CONDITIONS_FULFILLED" "READY_FOR_DELIVERY"

delivery status of the purchased addon

object (AddonTrackingData)

Responses

Request samples

Content type
application/json
{
  • "status": "CANCELLED",
  • "trackingData": {
    }
}

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"
}

Search cross client transactions

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

Authorizations:
plenigoToken
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.

orderId
integer <int64>

unique id of the order

subscriptionId
integer <int64>

unique id of the subscription

invoiceId
integer <int64>

unique id of the invoice

type
string
Enum: "LOSS" "REFUND" "PAYMENT"

unique id of the cross client transaction type

paidStatus
string
Enum: "OPEN" "PAID"

unique id of the cross client transaction paid status

connectedCompanyId
string

unique id of a connected company

Responses

Response samples

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

Get cross client transaction

Get cross client transaction that is identified by the passed address id.

Authorizations:
plenigoToken
path Parameters
crossClientTransactionId
required
integer <int64>

unique id of the cross client transaction id

Responses

Response samples

Content type
application/json
{
  • "crossClientTransactionId": 0,
  • "sourceCompanyId": "string",
  • "connectedCompanyId": "string",
  • "orderId": 0,
  • "subscriptionId": 0,
  • "invoiceId": 0,
  • "type": "LOSS",
  • "paidStatus": "OPEN",
  • "paymentMethod": "AMAZON_PAY",
  • "amount": 0,
  • "currency": "str",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "changedDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "createdByType": "API",
  • "changedBy": "string",
  • "changedByType": "API"
}

Update cross client transaction paid status

Update the paid status of a cross client transactions.

Authorizations:
plenigoToken
path Parameters
crossClientTransactionId
required
integer <int64>

unique id of the cross client transaction id

Request Body schema: application/json
paidStatus
string
Enum: "OPEN" "PAID"

paid status update

Responses

Request samples

Content type
application/json
{
  • "paidStatus": "OPEN"
}

Response samples

Content type
application/json
{
  • "crossClientTransactionId": 0,
  • "sourceCompanyId": "string",
  • "connectedCompanyId": "string",
  • "orderId": 0,
  • "subscriptionId": 0,
  • "invoiceId": 0,
  • "type": "LOSS",
  • "paidStatus": "OPEN",
  • "paymentMethod": "AMAZON_PAY",
  • "amount": 0,
  • "currency": "str",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "changedDate": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "createdByType": "API",
  • "changedBy": "string",
  • "changedByType": "API"
}

Subscriptions

Search subscriptions

Search all subscriptions that correspond to the given search conditions.

Authorizations:
plenigoToken
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

subscriptionItemId
integer <int64>

unique id of the subscription item to search for

externalSystemId
string

external system id defined by third party systems

Responses

Response samples

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

Search cross client subscriptions

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

Authorizations:
plenigoToken
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

subscriptionItemId
integer <int64>

unique id of the subscription item to search for

externalSystemId
string

external system id defined by third party systems

Responses

Response samples

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

Get subscription

Get subscription that is identified by the passed subscription id.

Authorizations:
plenigoToken
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 access

Change the access status of a subscription immediately.

Authorizations:
plenigoToken
path Parameters
subscriptionId
required
integer <int64>

unique id of the subscription

Request Body schema: application/json
accessBlocked
required
boolean

flag indicating if the access should be blocked

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": [
    ]
}

Change address

Change the address that is associated with a subscription.

Authorizations:
plenigoToken
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": [
    ]
}

Change analog invoice flag

Change analog invoice flag of a subscription.

Authorizations:
plenigoToken
path Parameters
subscriptionId
required
integer <int64>

unique id of the subscription

Request Body schema: application/json
analogInvoice
required
boolean

flag indicating if the subscription is an analog invoice

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": [
    ]
}

Cancel a running subscription at a given date

Cancel a running subscription to a given date.

Authorizations:
plenigoToken
path Parameters
subscriptionId
required
integer <int64>

unique id of the subscription

query Parameters
sendMail
boolean

flag indicating if an email should be send

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:
plenigoToken
path Parameters
subscriptionId
required
integer <int64>

unique id of the subscription

query Parameters
useAccountingPeriod
boolean

flag indicating that the accounting should be used for date calculation instead ot the term period

Responses

Response samples

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

Cancel now

Cancel subscription immediately and switch the subscription status to inactive.

Authorizations:
plenigoToken
path Parameters
subscriptionId
required
integer <int64>

unique id of the subscription

query Parameters
sendMail
boolean

flag indicating if an email should be send

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 regular

Cancel a subscription to the next regular end date.

Authorizations:
plenigoToken
path Parameters
subscriptionId
required
integer <int64>

unique id of the subscription

query Parameters
sendMail
boolean

flag indicating if an email should be send

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": [
    ]
}

Undo cancellation

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

Authorizations:
plenigoToken
path Parameters
subscriptionId
required
integer <int64>

unique id of the subscription

query Parameters
sendMail
boolean

flag indicating if an email should be send

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 discount

Change discount percentage of a subscription item.

Authorizations:
plenigoToken
path Parameters
subscriptionId
required
integer <int64>

unique id of the subscription

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

unique id of the subscription item to change discount for

discountPercentage
required
integer <int32> [ 0 .. 100 ]

discount offered to the subscription item

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": [
    ]
}

Change payment method

Change payment method of a subscription.

Authorizations:
plenigoToken
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": [
    ]
}

Add deliveries

Add deliveries to open deliveries count of a subscription.

Authorizations:
plenigoToken
path Parameters
subscriptionId
required
integer <int64>

unique id of the subscription

Request Body schema: application/json
deliveryAddition
required
integer <int32> [ 1 .. 100 ]

amount of deliveries to add to open deliveries

Responses

Request samples

Content type
application/json
{
  • "deliveryAddition": 1
}

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 quantity

Change quantity of a subscription item.

Authorizations:
plenigoToken
path Parameters
subscriptionId
required
integer <int64>

unique id of the subscription

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

unique id of the subscription item to change discount for

quantity
required
integer <int32> [ 1 .. 10000 ]

quantity of purchased entities

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": [
    ]
}

Change suppress invoice sending flag

Change suppress invoice sending flag of a subscription.

Authorizations:
plenigoToken
path Parameters
subscriptionId
required
integer <int64>

unique id of the subscription

Request Body schema: application/json
suppressInvoiceSending
required
boolean

flag indicating if the subscription invoice sending is suppressed

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": [
    ]
}

Change purchase order indicator

Change purchase order indicator of a subscription.

Authorizations:
plenigoToken
path Parameters
subscriptionId
required
integer <int64>

unique id of the subscription

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

purchase order indicator to set

Responses

Request samples

Content type
application/json
{
  • "purchaseOrderIndicator": "purchase order indicator"
}

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:
plenigoToken
path Parameters
subscriptionId
required
integer <int64>

unique id of the subscription

query Parameters
sendMail
boolean

flag indicating if an email should be send

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:
plenigoToken
path Parameters
subscriptionId
required
integer <int64>

unique id of the subscription

query Parameters
sendMail
boolean

flag indicating if an email should be send

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:
plenigoToken
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:
plenigoToken
path Parameters
subscriptionId
required
integer <int64>

unique id of the subscription

query Parameters
sendMail
boolean

flag indicating if an email should be send

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:
plenigoToken
path Parameters
subscriptionId
required
integer <int64>

unique id of the subscription

query Parameters
sendMail
boolean

flag indicating if an email should be send

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:
plenigoToken
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:
plenigoToken
path Parameters
chainId
required
integer <int64>

unique id of the subscription chain

Responses

Response samples

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

Replace additional chain data

Replace additional data of a subscription chain. All data will be replaced with the new data provided.

Authorizations:
plenigoToken
path Parameters
chainId
required
integer <int64>

unique id of the subscription chain

Request Body schema: application/json
object

Responses

Request samples

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

Response samples

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

Get chain status history

Returns status history associated with the chain associated with the provided chain id.

Authorizations:
plenigoToken
path Parameters
chainId
required
integer <int64>

unique id of the subscription chain

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.

Responses

Response samples

Content type
application/json
{
  • "statusChangeId": 0,
  • "customerId": "string",
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "chainId": 0,
  • "oldStatus": "ACTIVE",
  • "newStatus": "ACTIVE"
}

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:
plenigoToken
path Parameters
chainId
required
integer <int64>

unique id of the subscription chain

Responses

Response samples

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

Search subscription delivery dates for delivery list

Search all subscriptions delivery dates that correspond to the given search conditions.

Authorizations:
plenigoToken
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.

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

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

deliveryCustomerId
string

unique id of the delivery customer

subscriptionId
integer <int64>

unique id of the subscription

Responses

Response samples

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

Search cross client subscription delivery dates

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

Authorizations:
plenigoToken
path Parameters
deliveryListId
required
integer <int64>

unique id of the delivery list

deliveryListDateId
required
integer <int64>

unique id of the delivery list date

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.

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

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

deliveryCustomerId
string

unique id of the delivery customer

Responses

Response samples

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

Use cross client voucher

Use a cross client voucher to connect a cross client subscription.

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

unique id of the customer

voucherCode
string

voucher code

Responses

Request samples

Content type
application/json
{
  • "customerId": "string",
  • "voucherCode": "string"
}

Response samples

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

Get payment periods

Get last 100 payment periods of a subscription order by period start date descending.

Authorizations:
plenigoToken
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

subscriptionId
integer <int64>

unique id of the subscription

Responses

Response samples

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

Get payment period

Get the payment period.

Authorizations:
plenigoToken
path Parameters
subscriptionPaymentPeriodId
required
integer <int64>

unique id of the subscription payment period

Responses

Response samples

Content type
application/json
{
  • "subscriptionPaymentPeriodId": 12401,
  • "subscriptionId": 12400,
  • "customerId": 31000,
  • "startTime": "2019-02-01T00:00:00Z",
  • "endTime": "2019-02-28TT23:59:59Z",
  • "success": true,
  • "accessBlocked": false,
  • "accessBlockedInPeriod": false,
  • "bookingTries": 1,
  • "plenigoTransactionId": "1TCZCSdg0lFEGGG3JPbZODkZKG0",
  • "retryPaymentAllowed": false
}

Wallets

Create credit wallet

Create credit wallet.

Authorizations:
plenigoToken
Request Body schema: application/json
uniqueId
string^[0-9\-a-zA-Z]{2,30}$

unique id of the wallet for identification

creditCount
integer <int64> [ 1 .. 100000000 ]

credit count to create wallet with

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

unique id of the customer the credit wallet belongs to

Responses

Request samples

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

Response samples

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

Search credit wallets

Search credit wallets.

Authorizations:
plenigoToken

Responses

Response samples

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

Get credit wallet by id

Get credit wallet by id.

Authorizations:
plenigoToken
path Parameters
customerCreditWalletId
required
integer <int64>

id of the credit wallet

Responses

Response samples

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

Get credit uploads

Get credit wallet uploads.

Authorizations:
plenigoToken
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:
plenigoToken
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": [
    ]
}

Refill empty wallets

Refill empty wallets related to the even list

Authorizations:
plenigoToken
path Parameters
uniqueId
required
string

unique id of the wallet

Responses

Response samples

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

Upload

Uploads a credit to a given credit wallet.

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

id of the customer the credit usage should be accounted to

uniqueId
string^[0-9\-a-zA-Z]{2,30}$

unique id of the wallet to use

title
string <= 100 characters

title of upload

creditCount
integer <int64> [ 1 .. 100000000 ]

amount of credits to add

Responses

Request samples

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

Response samples

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

Use credit wallet

Uses a credit from a given credit wallet.

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

id of the customer the credit usage should be accounted to

uniqueId
required
string^[0-9\-a-zA-Z]{2,30}$

unique id of the wallet to use

creditsUsed
required
integer <int64> [ 1 .. 100000 ]

amount of credits used

reason
required
string <= 100 characters

reason for credit usage

category
string <= 100 characters

category for credit usage

Responses

Request samples

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

Response samples

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

Get credit wallet by unique id

Get credit wallet by unique id.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

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 by customer

Get credit wallet uploads.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

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 by customer

Get credit wallet usages.

Authorizations:
plenigoToken
path Parameters
customerId
required
string

unique id of the customer

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": [
    ]
}

Callback Logs

Search callback logs

Search all callback log entries that correspond to the given search conditions.

Authorizations:
plenigoToken
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

entityType
string
Enum: "APP_STORE_ORDER" "APP_STORE_SUBSCRIPTION" "CALLBACK_RENEWAL" "CROSS_CLIENT_ORDER" "CUSTOMER" "CUSTOMER_GDPR" "CUSTOMER_OPT_IN" "DOO_EVENT_ACCESS" "FAILED_PAYMENT" "INVOICE" "INVOICE_CANCELLATION" "INVOICE_CORRECTION" "ORDER" "PURCHASED_ADDON" "SUBSCRIPTION" "TRANSACTION" "VOUCHER_CAMPAIGN" "VOUCHER_CHANNEL"

entity type to get entries for

callbackType
string
Enum: "CANCELLATION" "CHANGE" "CONDITIONS_FULFILLED" "CREATION" "DELETION" "ENDED" "FINISHED" "PAYMENT_FAILED" "PAYMENT_REVOKED" "UNDO_CANCELLATION"

callback type to get entries for

Responses

Response samples

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

Get callback log entry

Get callback log entry that is identified by the passed callback log entry id.

Authorizations:
plenigoToken
path Parameters
callbackLogEntryId
required
integer <int64>

unique id of the callback log entry

Responses

Response samples

Content type
application/json
{
  • "callbackLogEntryId": 1230001,
  • "createdDate": "2019-01-01T07:53:23.450961Z",
  • "createdBy": "PLENIGO",
  • "createdByType": "SYSTEM",
  • "changedDate": "2019-01-01T07:53:23.450961Z",
  • "changedBy": "PLENIGO",
  • "changedByType": "SYSTEM",
  • "entityType": "CUSTOMER",
  • "callbackType": "CREATION",
  • "entityVersion": "3.0",
  • "entityId": "1240003",
  • "success": false,
  • "erroMsg": "Could not reach host https://www.example.com."
}

Downloads

Search downloads

Search all downloads log entries that correspond to the given search conditions.

Authorizations:
plenigoToken
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.

downloadType
string
Enum: "DELIVERY_LIST" "DELIVERY_NOTE_LIST" "ANALOG_INVOICE_LIST"

download type of the downlaod

fileType
string
Enum: "CSV" "PDF" "ZIP"

file type of the downlaod

Responses

Response samples

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

Get download

Get download that is identified by the passed download id.

Authorizations:
plenigoToken
path Parameters
downloadId
required
integer <int64>

unique id of the download

Responses

Response samples

Content type
application/json
{
  • "downloadId": 1230001,
  • "uploadedDate": "2019-01-01T07:53:23.450961Z",
  • "downloadType": "DELIVERY_LIST",
  • "fileType": "CSV",
  • "fileSize": 1924,
  • "fileName": "delivery_list_2019_01_01"
}

Get file

Get download file that is identified by the passed download id.

Authorizations:
plenigoToken
path Parameters
downloadId
required
integer <int64>

unique id of the download

Responses

Response samples

Content type
application/json
{
  • "fileType": "CSV",
  • "fileName": "Delivery list",
  • "file": "biwgSm9naHVydCB1bmQgUXVhcms="
}

Mail Logs

Search mail log entries

Search all mail log entries that correspond to the given search conditions.

Authorizations:
plenigoToken
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

mailTemplateType
string
Enum: "CHANGE_EMAIL" "CROSS_SELLING" "INVOICE" "ORDER" "ORDER_ITEM_VOUCHER" "PAYMENT_FAILED" "PAYMENT_METHOD_CHANGED" "RECURRING_PAYMENT_FAILED" "RECURRING_PAYMENT_TRY_FAILED" "REGISTRATION_ALREADY_FINISHED" "REGISTRATION_COMPLETION" "REGISTRATION_FINISHED" "RESET_PASSWORD" "RESET_PASSWORD_FINISHED" "SUBSCRIPTION_CANCELED" "SUBSCRIPTION_DELIVERY_PAUSED" "SUBSCRIPTION_DELIVERY_PAUSED_CANCELED" "SUBSCRIPTION_PAUSED" "SUBSCRIPTION_PAUSED_CANCELED" "SUBSCRIPTION_CANCELLATION_TERMINATION" "SUBSCRIPTION_RELATION_RULE" "WELCOME_MAIL"

mail template type of the mail sent

errorOnly
boolean

flag indicating if only failed mail logs should be returned

Responses

Response samples

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

Get mail log entry

Get mail log entry that is identified by the passed mail log entry id.

Authorizations:
plenigoToken
path Parameters
mailLogEntryId
required
integer <int64>

unique id of the mail log entry

Responses

Response samples

Content type
application/json
{
  • "mailLogEntryId": 1230001,
  • "changedDate": "2019-01-01T07:53:23.450961Z",
  • "customerId": "83432341",
  • "mailSettingsType": "EXTERNAL",
  • "mailTemplateType": "CHANGE_EMAIL",
  • "to": "receiver@example.com",
  • "from": "merchant@example.com",
  • "bcc": "copy@example.com",
  • "replyTo": "support@example.com",
  • "subject": "Your new email address",
  • "success": false,
  • "errorReason": "Mail could not be delivered.",
  • "errorDetail": "Could not successfully deliver mail because mail box is full."
}

Sftp Logs

Search SFTP log entries

Search all SFTP log entries that correspond to the given search conditions.

Authorizations:
plenigoToken
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 SFTP log entry

Get SFTP log entry that is identified by the passed sftp log entry id.

Authorizations:
plenigoToken
path Parameters
sftpLogEntryId
required
integer <int64>

unique id of the sftp log entry

Responses

Response samples

Content type
application/json
{
  • "sftpLogEntryId": 49000,
  • "changedDate": "2019-01-01T07:53:23.450961Z",
  • "server": "example.com:22",
  • "username": "user1",
  • "targetDirectory": "target/directory/",
  • "success": false,
  • "errorMsg": "connection lost"
}

Api Access Tokens

Get renewed API token

Get renewed API access token identified by renewed token

Authorizations:
plenigoToken
query Parameters
requestToken
required
string

the request token to get the new API token

Responses

Response samples

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

Additional Data Selections

Get additional data selections

Returns additional data selections.

Authorizations:
plenigoToken

Responses

Response samples

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

Update additional data selections.

Update additional data selections.

Authorizations:
plenigoToken
Request Body schema: application/json
Array of objects (AdditionalDataSelection)

Responses

Request samples

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

Response samples

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

Blocked ibans

Get blocked ibans

Get blocked ibans for a company.

Authorizations:
plenigoToken
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.

iban
string [ 18 .. 32 ] characters

Responses

Response samples

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

Create blocked iban

Create a blocked iban for a company.

Authorizations:
plenigoToken
Request Body schema: application/json
iban
required
string [ 18 .. 32 ] characters
description
string <= 1000 characters

description of the blocked iban

Responses

Request samples

Content type
application/json
{
  • "iban": "stringstringstring",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "blockedIbanId": 100001,
  • "iban": "GB19123412341234123412",
  • "description": "This iban is not allowed."
}

Get blocked iban

Get blocked iban for a company.

Authorizations:
plenigoToken
path Parameters
blockedIbanId
required
integer <int64>

unique id of the blocked iban

Responses

Response samples

Content type
application/json
{
  • "blockedIbanId": 100001,
  • "iban": "GB19123412341234123412",
  • "description": "This iban is not allowed."
}

Delete a blocked iban

Delete a blocked iban for a company.

Authorizations:
plenigoToken
path Parameters
blockedIbanId
required
integer <int64>

unique id of the blocked iban

Responses

Response samples

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

Customer Cancellation Reasons

Search cancellation reasons

Search all cancellation reasons that correspond to the given search conditions.

Authorizations:
plenigoToken
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 cancellation reasons

Get cancellation reasons that is identified by the passed cancellation reasons id.

Authorizations:
plenigoToken
path Parameters
customerCancellationReasonId
required
string

unique id of a customer cancellation reason

Responses

Response samples

Content type
application/json
{
  • "customerCancellationReasonId": 120302,
  • "createdDate": "2019-01-01T07:53:23.450961Z",
  • "createdBy": "PLENIGO",
  • "createdByType": "SYSTEM",
  • "changedDate": "2019-01-01T07:53:23.450961Z",
  • "changedBy": "PLENIGO",
  • "changedByType": "SYSTEM",
  • "internalTitle": "Too expensive",
  • "active": true,
  • "priority": 1,
  • "uniqueId": "too_expensive",
  • "translations": [
    ]
}

Customer OptIns

Search advertisement opt ins

Search all advertisement opt ins that correspond to the given search conditions.

Authorizations:
plenigoToken
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 advertisement opt in

Get advertisement opt in that is identified by the passed advertisement opt in id.

Authorizations:
plenigoToken
path Parameters
customerOptInId
required
string

unique id of a customer opt in

Responses

Response samples

Content type
application/json
{
  • "customerOptInId": 120302,
  • "createdDate": "2019-01-01T07:53:23.450961Z",
  • "createdBy": "PLENIGO",
  • "createdByType": "SYSTEM",
  • "changedDate": "2019-01-01T07:53:23.450961Z",
  • "changedBy": "PLENIGO",
  • "changedByType": "SYSTEM",
  • "internalTitle": "Main opt in",
  • "active": true,
  • "uniqueId": "V1.0",
  • "activationTime": "2020-03-21T17:32:12Z",
  • "translations": [
    ]
}

Customer Terms

Search terms and conditions

Search all terms and conditions that correspond to the given search conditions.

Authorizations:
plenigoToken
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 terms and conditions

Get terms and conditions that is identified by the passed terms and conditions id.

Authorizations:
plenigoToken
path Parameters
customerTermId
required
string

unique id of a customer term

Responses

Response samples

Content type
application/json
{
  • "customerTermId": 120302,
  • "internalTitle": "Main term",
  • "active": true,
  • "uniqueId": "V1.0",
  • "activationTime": "2020-03-21T17:32:12Z",
  • "translations": [
    ]
}

Sort Tree Leafs

Search sort tree leafs

Search all sort tree leafs that correspond to the given search conditions.

Authorizations:
plenigoToken
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": [
    ]
}

Search sort tree leafs by type

Search all sort tree leafs that correspond to the given search conditions and type.

Authorizations:
plenigoToken
path Parameters
type
required
string
Enum: "OFFER" "PRICE_ISSUE" "PRODUCT_CONTRACT" "TEXT_MODULE" "CHECKOUT_VARIANT" "CHECKOUT_VARIANT_ADDRESS" "CHECKOUT_VARIANT_CONTENT" "CHECKOUT_VARIANT_DESIGN" "CHECKOUT_VARIANT_PAYMENT"

type of the sort tree leaf

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 sort tree leaf by id

Get sort tree leaf that is identified by the passed sort tree leaf id.

Authorizations:
plenigoToken
path Parameters
sortTreeLeafId
required
integer <int64>

unique id of the sort tree leaf

Responses

Response samples

Content type
application/json
{
  • "sortTreeLeafId": 9002,
  • "name": "New products",
  • "parentLeafId": 9001
}

Get sort tree leaf by id and type

Get sort tree leaf that is identified by the passed sort tree leaf id and type.

Authorizations:
plenigoToken
path Parameters
sortTreeLeafId
required
integer <int64>

unique id of the sort tree leaf

type
required
string
Enum: "OFFER" "PRICE_ISSUE" "PRODUCT_CONTRACT" "TEXT_MODULE" "CHECKOUT_VARIANT" "CHECKOUT_VARIANT_ADDRESS" "CHECKOUT_VARIANT_CONTENT" "CHECKOUT_VARIANT_DESIGN" "CHECKOUT_VARIANT_PAYMENT"

type of the sort tree leaf

Responses

Response samples

Content type
application/json
{
  • "sortTreeLeafId": 9002,
  • "name": "New products",
  • "parentLeafId": 9001
}

Text Module Settings

Search text modules

Search all text modules that correspond to the given search conditions.

Authorizations:
plenigoToken
query Parameters
type
required
string
Enum: "LINK" "HTML_TEXT" "PLAIN_TEXT"

type of the text module

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.

leafId
integer <int64>

unique id of the sort tree leaf

Responses

Response samples

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

Get text module

Get text module that is identified by the passed text module id.

Authorizations:
plenigoToken
path Parameters
textModuleId
required
string

unique id of a text module

Responses

Response samples

Content type
application/json
{
  • "textModuleId": 123000,
  • "internalTitle": "Text module",
  • "type": "HTML_TEXT",
  • "translations": [
    ]
}