| Requires any of the roles: | Agent, Administrator, Agent, Administrator, Agent, Administrator |
| GET,OPTIONS | /v1/StripeCustomer | ||
|---|---|---|---|
| PUT,OPTIONS | /v1/StripeCustomer | ||
| POST,OPTIONS | /v1/StripeCustomer |
"use strict";
export class StripeCustomer {
/** @param {{StripeCustomerId?:number,StripeMerchantId?:number,CustomerId?:number,StripeId?:string,AgentId?:number,StripeCustomerSessionClientSecret?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
StripeCustomerId;
/** @type {number} */
StripeMerchantId;
/** @type {number} */
CustomerId;
/** @type {string} */
StripeId;
/** @type {number} */
AgentId;
/** @type {string} */
StripeCustomerSessionClientSecret;
}
export class StripeCustomerResponse {
/** @param {{ResponseStatus?:ResponseStatus,StripeCustomer?:StripeCustomer,Success?:boolean,Message?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {ResponseStatus} */
ResponseStatus;
/** @type {StripeCustomer} */
StripeCustomer;
/** @type {boolean} */
Success;
/** @type {string} */
Message;
}
export class Customer {
/** @param {{ID?:number,CustomerCode?:string,BusinessName?:string,FirstName?:string,LastName?:string,Email?:string,UID?:string,AgentId?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
ID;
/** @type {string} */
CustomerCode;
/** @type {string} */
BusinessName;
/** @type {string} */
FirstName;
/** @type {string} */
LastName;
/** @type {string} */
Email;
/** @type {string} */
UID;
/** @type {number} */
AgentId;
}
export class Address {
/** @param {{ID?:number,AddressTypeID?:number,AddressContact?:string,AttentionTo?:string,AddressLine1?:string,AddressLine2?:string,AddressLine3?:string,AddressCity?:string,AddressState?:string,AddressZip?:string,AddressCountry?:string,PhoneNumber?:string,FaxNumber?:string,UID?:string,Name?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
ID;
/** @type {number} */
AddressTypeID;
/** @type {string} */
AddressContact;
/** @type {string} */
AttentionTo;
/** @type {string} */
AddressLine1;
/** @type {string} */
AddressLine2;
/** @type {string} */
AddressLine3;
/** @type {string} */
AddressCity;
/** @type {string} */
AddressState;
/** @type {string} */
AddressZip;
/** @type {string} */
AddressCountry;
/** @type {string} */
PhoneNumber;
/** @type {string} */
FaxNumber;
/** @type {string} */
UID;
/** @type {string} */
Name;
}
export class StripeCustomerRequest {
/** @param {{Customer?:Customer,Address?:Address}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {Customer} */
Customer;
/** @type {Address} */
Address;
}
JavaScript StripeCustomerRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/StripeCustomer HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<StripeCustomerRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Address>
<AddressCity>String</AddressCity>
<AddressContact>String</AddressContact>
<AddressCountry>String</AddressCountry>
<AddressLine1>String</AddressLine1>
<AddressLine2>String</AddressLine2>
<AddressLine3>String</AddressLine3>
<AddressState>String</AddressState>
<AddressTypeID>0</AddressTypeID>
<AddressZip>String</AddressZip>
<AttentionTo>String</AttentionTo>
<FaxNumber>String</FaxNumber>
<ID>0</ID>
<Name>String</Name>
<PhoneNumber>String</PhoneNumber>
<UID>00000000-0000-0000-0000-000000000000</UID>
</Address>
<Customer>
<AgentId>0</AgentId>
<BusinessName>String</BusinessName>
<CustomerCode>String</CustomerCode>
<Email>String</Email>
<FirstName>String</FirstName>
<ID>0</ID>
<LastName>String</LastName>
<UID>00000000-0000-0000-0000-000000000000</UID>
</Customer>
</StripeCustomerRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<StripeCustomerResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Message>String</Message>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<StripeCustomer>
<AgentId>0</AgentId>
<CustomerId>0</CustomerId>
<StripeCustomerId>0</StripeCustomerId>
<StripeCustomerSessionClientSecret>String</StripeCustomerSessionClientSecret>
<StripeId>String</StripeId>
<StripeMerchantId>0</StripeMerchantId>
</StripeCustomer>
<Success>false</Success>
</StripeCustomerResponse>