Customer, Account & Subscription Management

Customer Management

Create Customer

Parameter Description

requestId

Unique ID of the Request.

transactionId

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

customer.profile

Profile of the Customer to be used for creation. REF to 'CustomerProfile.internalCode'.

customer.externalId

External ID of the Customer.

customer.customName

Custom Customer name.

customer.segment

Segment of the Customer. REF to 'CustomerSegment.internalCode'.

testCustomer

Indicates whether Customer is a Test Customer.

state

Initial State of the Customer.

stateReason

Reason of the State.

stateValidFrom

Date/Time from when State is valid.

customer.customAttributes.<key>

List of Customer’s Custom Attributes, Key-Value pairs.

Update Customer’s External Id

Parameter Description

requestId

Unique ID of the Request.

transactionId

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

customer.refId

Ref ID of the Customer.

customer.externalId

External ID of the Customer.

customer.externalId.new

New External ID of the Customer.

Update Customer’s State

Parameter Description

requestId

Unique ID of the Request.

transactionId

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

customer.refId

Ref ID of the Customer.

customer.externalId

External ID of the Customer.

state

New State of the Customer.

stateReason

Reason of the State.

stateValidFrom

Date/Time from when State is valid.

Update Customer’s Custom Name

Parameter Description

requestId

Unique ID of the Request.

transactionId

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

customer.refId

Ref ID of the Customer.

customer.externalId

External ID of the Customer.

customer.customName

New Custom Name of the Customer.

Update Customer’s Custom Attributes

Parameter Description

requestId

Unique ID of the Request.

transactionId

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

customer.refId

Ref ID of the Customer.

customer.externalId

External ID of the Customer.

merge

Indicates whether provided custom attributes shall be merged with already stored.

customer.customAttributes.<key>

List of new Customer’s Custom Attributes, Key-Value pairs.

Update Customer’s Segment

Parameter Description

requestId

Unique ID of the Request.

transactionId

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

customer.refId

Ref ID of the Customer.

customer.externalId

External ID of the Customer.

customer.segment

New Segment of the Customer. REF to 'CustomerSegment.internalCode'.

Create Subscription on Customer

Parameter Description

requestId

Unique ID of the Request.

transactionId

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

offer

Code of the Offer. REF to 'Offer.internalCode'.

customer.refId

Ref ID of the Customer.

customer.externalId

External ID of the Customer.

subscription.externalId

External ID of the Subscription.

subscription.customName

Custom Subscription name.

state

Initial State of the Customer.

stateReason

Reason of the State.

stateValidFrom

Date/Time from when State is valid.

subscription.customAttributes.<key>

List of Subscription’s Custom Attributes, Key-Value pairs.

Account Management

Create Account

Parameter Description

requestId

Unique ID of the Request.

transactionId

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

customer.refId

Ref ID of the Customer under which the Account will be created.

customer.externalId

External ID of the Customer under which the Account will be created.

account.parent.refId

Ref ID of the Parent Account under which the Account will be created.

account.profile

Profile of the Account to be used for creation. REF to 'AccountProfile.internalCode'.

account.externalId

External ID of the Account.

account.customName

Custom Account name.

account.segment

Segment of the Account. REF to 'AccountSegment.internalCode'.

account.type

Type of the Account to be used for creation. REF to 'AccountType.internalCode'.

billCycle

BillCycle to be assigned. REF to 'BillCycle.internalCode'.

currency

Currency ISO 4217 code (3 letters). REF to 'Currency.code'.

paymentResponsible

Indicates whether Account is Payment Responsible.

taxExemption

Indicates whether Account is subject of Tax exemption. If true, TaxExemptionType on Invoice is set to ACCOUNT.

taxResidence

Tax Residence or the Payment Responsible Account.

testAccount

Indicates whether Account is a Test Account.

state

Initial State of the Account.

stateReason

Reason of the State.

stateValidFrom

Date/Time from when State is valid.

account.customAttributes.<key>

List of Account’s Custom Attributes, Key-Value pairs.

Update Account’s External Id

Parameter Description

requestId

Unique ID of the Request.

transactionId

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

account.refId

Ref ID of the Account.

account.externalId

External ID of the Account.

account.externalId.new

New External ID of the Account.

Update Account’s State

Parameter Description

requestId

Unique ID of the Request.

transactionId

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

account.refId

Ref ID of the Account.

account.externalId

External ID of the Account.

state

New State of the Account.

stateReason

Reason of the State.

stateValidFrom

Date/Time from when State is valid.

Update Account’s Custom Name

Parameter Description

requestId

Unique ID of the Request.

transactionId

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

account.refId

Ref ID of the Account.

account.externalId

External ID of the Account.

account.customName

New Custom Name of the Account.

Update Account’s Custom Attributes

Parameter Description

requestId

Unique ID of the Request.

transactionId

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

account.refId

Ref ID of the Account.

account.externalId

External ID of the Account.

merge

Indicates whether provided custom attributes shall be merged with already stored.

account.customAttributes.<key>

List of new Account’s Custom Attributes, Key-Value pairs.

Update Account’s Segment

Parameter Description

requestId

Unique ID of the Request.

transactionId

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

account.refId

Ref ID of the Account.

account.externalId

External ID of the Account.

account.segment

New Segment of the Account. REF to 'AccountSegment.internalCode'.

Update Account’s Bill Cycle

Parameter Description

requestId

Unique ID of the Request.

transactionId

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

account.refId

Ref ID of the Account.

account.externalId

External ID of the Account.

billCycle

New Bill Cycle. REF to 'BillCycle.internalCode'.

validFrom

Timestamp from when the new Bill Cycle is valid. If null, change is immediate.

Update Account’s Tax Exemption

Parameter Description

requestId

Unique ID of the Request.

transactionId

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

account.refId

Ref ID of the Account.

account.externalId

External ID of the Account.

taxExemption

Indicates whether Account is subject of Tax exemption. If true, TaxExemptionType on Invoice is set to ACCOUNT.

taxResidence

Tax Residence or the Payment Responsible Account.

Create Subscription on Account

Parameter Description

requestId

Unique ID of the Request.

transactionId

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

offer

Code of the Offer. REF to 'Offer.internalCode'.

account.refId

Ref ID of the Account.

account.externalId

External ID of the Account.

subscription.externalId

External ID of the Subscription.

subscription.customName

Custom Subscription name.

state

Initial State of the Account.

stateReason

Reason of the State.

stateValidFrom

Date/Time from when State is valid.

subscription.customAttributes.<key>

List of Subscription’s Custom Attributes, Key-Value pairs.

Subscriber Management

Create Subscriber

Parameter Description

requestId

Unique ID of the Request.

transactionId

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

account.refId

Ref ID of the Account under which the Subscriber will be created.

account.externalId

External ID of the Account under which the Subscriber will be created.

subscriber.profile

Profile of the Subscriber to be used for creation. REF to 'SubscriberProfile.internalCode'.

subscriber.externalId

External ID of the Subscriber.

subscriber.customName

Custom Subscriber name.

subscriber.segment

Segment of the Subscriber. REF to 'SubscriberSegment.internalCode'.

primaryResourceType

Type of the Primary Resource which will be used for guiding to Subscriber. REF to 'ResourceType.internalCode'.

primaryResource

Value of the Primary Resource which will be used for guiding to Subscriber.

state

Initial State of the Subscriber.

stateReason

Reason of the State.

stateValidFrom

Date/Time from when State is valid.

subscriber.customAttributes.<key>

List of Subscriber’s Custom Attributes, Key-Value pairs.

MDC

MDC Key MDC Value

entityName

'Account'

entityRefId

Ref ID of the Account.

Update Subscriber’s External Id

Parameter Description

requestId

Unique ID of the Request.

transactionId

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

subscriber.refId

Ref ID of the Subscriber.

subscriber.externalId

External ID of the Subscriber.

subscriber.externalId.new

New External ID of the Subscriber.

Update Subscriber’s State

Parameter Description

requestId

Unique ID of the Request.

transactionId

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

subscriber.refId

Ref ID of the Subscriber.

subscriber.externalId

External ID of the Subscriber.

state

New State of the Subscriber.

stateReason

Reason of the State.

stateValidFrom

Date/Time from when State is valid.

Update Subscriber’s Custom Name

Parameter Description

requestId

Unique ID of the Request.

transactionId

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

subscriber.refId

Ref ID of the Subscriber.

subscriber.externalId

External ID of the Subscriber.

subscriber.customName

New Custom Name of the Subscriber.

Update Subscriber’s Custom Name

Parameter Description

requestId

Unique ID of the Request.

transactionId

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

subscriber.refId

Ref ID of the Subscriber.

subscriber.externalId

External ID of the Subscriber.

merge

Indicates whether provided custom attributes shall be merged with already stored.

subscriber.customAttributes.<key>

List of Subscriber’s Custom Attributes, Key-Value pairs.

Update Subscriber’s Segment

Parameter Description

requestId

Unique ID of the Request.

transactionId

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

subscriber.refId

Ref ID of the Subscriber.

subscriber.externalId

External ID of the Subscriber.

subscriber.segment

New Segment of the Subscriber. REF to 'SubscriberSegment.internalCode'.

Create Subscription on Subscriber

Parameter Description

requestId

Unique ID of the Request.

transactionId

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

offer

Code of the Offer. REF to 'Offer.internalCode'.

subscriber.refId

Ref ID of the Subscriber.

subscriber.externalId

External ID of the Subscriber.

subscription.externalId

External ID of the Subscription.

subscription.customName

Custom Subscription name.

state

Initial State of the Subscriber.

stateReason

Reason of the State.

stateValidFrom

Date/Time from when State is valid.

subscription.customAttributes.<key>

List of Subscription’s Custom Attributes, Key-Value pairs.

Create Subscriber Resource

Parameter Description

requestId

Unique ID of the Request.

transactionId

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

subscriber.refId

Ref ID of the Subscriber.

subscriber.externalId

External ID of the Subscriber.

resourceType

Type of the Resource which will be used for guiding to Subscriber. REF to 'ResourceType.internalCode'.

resource

Value of the Resource which will be used for guiding to Subscriber.

Swap Subscriber Resource

Parameter Description

requestId

Unique ID of the Request.

transactionId

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

subscriber.refId

Ref ID of the Subscriber.

subscriber.externalId

External ID of the Subscriber.

resourceType

Type of the Resource which will be used for guiding to Subscriber. REF to 'ResourceType.internalCode'.

swapResource

Value of the Resource which will be swapped.

resource

New value of the Resource which will be used for guiding to Subscriber.

Read Subscriber

Parameter Description

requestId

Unique ID of the Request.

transactionId

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

subscriber.refId

Ref ID of the Subscriber.

subscriber.externalId

External ID of the Subscriber.

resources

Indicates whether reads also Resources belonging to Subscriber.

offers

Indicates whether reads also Offer Subscriptions belonging to Subscriber.

Read Subscriber Resource

Parameter Description

requestId

Unique ID of the Request.

transactionId

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

Subscription Management

Update Subscription’s External Id

Parameter Description

requestId

Unique ID of the Request.

transactionId

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

subscription.refId

Ref ID of the Subscription.

subscription.externalId

External ID of the Subscription.

subscription.externalId.new

New External ID of the Subscription.

Update Subscription’s State

Parameter Description

requestId

Unique ID of the Request.

transactionId

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

subscription.refId

Ref ID of the Subscription.

subscription.externalId

External ID of the Subscription.

state

New State of the Subscription.

stateReason

Reason of the State.

stateValidFrom

Date/Time from when State is valid.

Update Subscription’s Custom Name

Parameter Description

requestId

Unique ID of the Request.

transactionId

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

subscription.refId

Ref ID of the Subscription.

subscription.externalId

External ID of the Subscription.

subscription.customName

New Custom Name of the Subscription.

Update Subscription’s Custom Attributes

Parameter Description

requestId

Unique ID of the Request.

transactionId

Business Transaction ID for correlating multiple request in external systems. If not provided, Request ID will be copied.

subscription.refId

Ref ID of the Subscription.

subscription.externalId

External ID of the Subscription.