Customer
Customer
Set up customer profiles. You will need these profiles to store credit cards and use those credit cards for different payment types.
BASE URI
https://apigateway.payfirma.com/customer-service
Create a customer
Create a new customer profile using provided information
HTTPS POST
/customer
Example Request:
curl --include \
--request POST \
--header "Content-Type: application/json" \
--header "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJhY2Nlc3NfdG9rZW4iOiIxM2EyN2ViZS1iZTEwLTQzY2ItYjFmOC1lYjY4ZWEwOGFlNGIiLCJleHAiOjE0NTcwNTU0NjN9._KIfokRmM38MjP-q2pxB6Lk_-dcg2VnLg9QiuwksxKU" \
--data-binary "{
\"email\": \"brandon@stark.com\",
\"first_name\": \"Brandon\",
\"last_name\": \"Stark\",
\"company\": \"Payfirma\",
\"bcc_emails\": \"john.snow@stark.com\",
\"telephone\": \"1234567891\",
\"address1\": \"No. 1 Road\",
\"address2\": \"Street 2\",
\"city\": \"Vancouver\",
\"province\": \"BC\",
\"country\": \"Canada\",
\"postal_code\": \"V6E 1B2\",
\"custom_id\": \"Internal456\"
}" \
"https://apigateway.payfirma.com/customer-service/customer"
Example Response Body:
{
'id': 2992429,
'lookup_id': 'NV0B6eZB06',
'email': 'brandon@stark.com',
'first_name': 'Brandon',
'last_name': 'Stark',
'company': 'Payfirma',
'bcc_emails': 'john.snow@stark.com',
'telephone': '1234567891',
'address1': 'No. 1 Road',
'address2': 'Street 2',
'city': 'Vancouver',
'province': 'BC',
'country': 'Canada',
'postal_code': 'V6E 1B2',
'custom_id': 'Internal456',
'cards':[{"id":123456,"lookup_id":"34cvb54564dfc","card_expiry":"01/20","card_prefix":"4111","card_suffix":"1111","is_default":true,"card_description":"test card"}],
'subscriptions':[{"id":123456,"lookup_id":"34cvb54564dfc","plan_id":987654,"plan_lookup_id":"98Avb98765dfc","name":"Sample Daily Plan","status":"ACTIVE","amount":10.99,"currency":"CAD","frequency":"DAILY","last_success":1467760023000,"last_run":1467760023000,"next_run":1467760023000,"total_cycles":10,"completed_cycles":3,"remaining_cycles":7,"failed_attempts":1,"delinquent_cycles":0,"delinquent_since":1467760023000}],
}
Retrieve a specific customer
Get all the attributes of a specific customer profile by using their lookup_id.
HTTPS GET
/customer/{customer_lookup_id}
Example Request:
curl --include \
--header "Content-Type: application/json" \
--header "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJhY2Nlc3NfdG9rZW4iOiIxM2EyN2ViZS1iZTEwLTQzY2ItYjFmOC1lYjY4ZWEwOGFlNGIiLCJleHAiOjE0NTcwNTU0NjN9._KIfokRmM38MjP-q2pxB6Lk_-dcg2VnLg9QiuwksxKU" \
"https://apigateway.payfirma.com/customer-service/customer/NV0B6eZB06"
Example Response Body:
{
'id': 2992429,
'lookup_id': 'NV0B6eZB06',
'email': 'brandon@stark.com',
'first_name': 'Brandon',
'last_name': 'Stark',
'company': 'Payfirma',
'bcc_emails': 'john.snow@stark.com',
'telephone': '1234567891',
'address1': 'No. 1 Road',
'address2': 'Street 2',
'city': 'Vancouver',
'province': 'BC',
'country': 'Canada',
'postal_code': 'V6E 1B2',
'custom_id': 'Internal456',
'cards':[{"id":123456,"lookup_id":"34cvb54564dfc","card_expiry":"01/20","card_prefix":"4111","card_suffix":"1111","is_default":true,"card_description":"test card"}],
'subscriptions':[{"id":123456,"lookup_id":"34cvb54564dfc","plan_id":987654,"plan_lookup_id":"98Avb98765dfc","name":"Sample Daily Plan","status":"ACTIVE","amount":10.99,"currency":"CAD","frequency":"DAILY","last_success":1467760023000,"last_run":1467760023000,"next_run":1467760023000,"total_cycles":10,"completed_cycles":3,"remaining_cycles":7,"failed_attempts":1,"delinquent_cycles":0,"delinquent_since":1467760023000}],
}
Retrieve all customers for a specific account
Requests a list of all customers according to the parameters you specify.
HTTPS GET
/customer{?limit,before,after,email_address,first_name,last_name,company,with_subscription}
Example Request:
curl --include \
--header "Content-Type: application/json" \
--header "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJhY2Nlc3NfdG9rZW4iOiIxM2EyN2ViZS1iZTEwLTQzY2ItYjFmOC1lYjY4ZWEwOGFlNGIiLCJleHAiOjE0NTcwNTU0NjN9._KIfokRmM38MjP-q2pxB6Lk_-dcg2VnLg9QiuwksxKU" \
"https://apigateway.payfirma.com/customer-service/customer?limit=100&before=%273X67XWEE%27&after=%27XWERE836%27&email_address=%27brandon%40stark.com%27&first_name=%27Brandon%27&last_name=%27Stark%27&company=Payfirma&with_subscription=true"
Example Response Body:
{
'entities':[{"id":2992429,"lookup_id":"NV0B6eZB06","email":"brandon@stark.com","first_name":"Brandon","last_name":"Stark","company":"Payfirma","bcc_emails":"john.snow@stark.com","telephone":"1234567891","address1":"No. 1 Road","address2":"Street 2","city":"Vancouver","province":"BC","country":"Canada","postal_code":"V6E 1B2","custom_id":"Internal456","cards":[{"id":123456,"lookup_id":"34cvb54564dfc","card_expiry":"01/20","card_prefix":"4111","card_suffix":"1111","is_default":true,"card_description":"test card"}],"subscriptions":[{"id":123456,"lookup_id":"34cvb54564dfc","plan_id":987654,"plan_lookup_id":"98Avb98765dfc","name":"Sample Daily Plan","status":"ACTIVE","amount":10.99,"currency":"CAD","frequency":"DAILY","last_success":1467760023000,"last_run":1467760023000,"next_run":1467760023000,"total_cycles":10,"completed_cycles":3,"remaining_cycles":7,"failed_attempts":1,"delinquent_cycles":0,"delinquent_since":1467760023000}]}],
'paging': {"cursors":{"before":"51pmdq8z5rdbRWoKYrje","after":"xv9Aq54WEy3RyWEBXypK"}},
}
Retrieve plan's customers
Query all customers who subscribed to a given plan lookup Id
HTTPS GET
/customer/plan/{plan_lookup_id}/{?limit,before,after,email_address,first_name,last_name,company}
Example Request:
curl --include \
--header "Content-Type: application/json" \
--header "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJhY2Nlc3NfdG9rZW4iOiIxM2EyN2ViZS1iZTEwLTQzY2ItYjFmOC1lYjY4ZWEwOGFlNGIiLCJleHAiOjE0NTcwNTU0NjN9._KIfokRmM38MjP-q2pxB6Lk_-dcg2VnLg9QiuwksxKU" \
"https://apigateway.payfirma.com/customer-service/customer/plan/99ffb59876mnb?limit=100&before="3X67XWEE"&after="XWERE836"&email_address="brandon@stark.com"&first_name="Brandon"&last_name="Stark"&company=Payfirma"
Example Response Body:
{
'entities':[{"id":2992429,"lookup_id":"NV0B6eZB06","email":"brandon@stark.com","first_name":"Brandon","last_name":"Stark","company":"Payfirma","bcc_emails":"john.snow@stark.com","telephone":"1234567891","address1":"No. 1 Road","address2":"Street 2","city":"Vancouver","province":"BC","country":"Canada","postal_code":"V6E 1B2","custom_id":"Internal456","cards":[{"id":123456,"lookup_id":"34cvb54564dfc","card_expiry":"01/20","card_prefix":"4111","card_suffix":"1111","is_default":true,"card_description":"test card"}],"subscriptions":[{"id":123456,"lookup_id":"34cvb54564dfc","plan_id":987654,"plan_lookup_id":"98Avb98765dfc","name":"Sample Daily Plan","status":"ACTIVE","amount":10.99,"currency":"CAD","frequency":"DAILY","last_success":1467760023000,"last_run":1467760023000,"next_run":1467760023000,"total_cycles":10,"completed_cycles":3,"remaining_cycles":7,"failed_attempts":1,"delinquent_cycles":0,"delinquent_since":1467760023000}]}],
'paging': {"cursors":{"before":"51pmdq8z5rdbRWoKYrje","after":"xv9Aq54WEy3RyWEBXypK"}},
}
Update a customer
Change the attributes of a customer profile using their customer lookup_id.
HTTPS PUT
/customer/{customer_lookup_id}
Example Request:
curl --include \
--request PUT \
--header "Content-Type: application/json" \
--header "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJhY2Nlc3NfdG9rZW4iOiIxM2EyN2ViZS1iZTEwLTQzY2ItYjFmOC1lYjY4ZWEwOGFlNGIiLCJleHAiOjE0NTcwNTU0NjN9._KIfokRmM38MjP-q2pxB6Lk_-dcg2VnLg9QiuwksxKU" \
--data-binary "{
\"email\": \"brandon@stark.com\",
\"first_name\": \"Brandon\",
\"last_name\": \"Stark\",
\"company\": \"Payfirma\",
\"bcc_emails\": \"john.snow@stark.com\",
\"telephone\": \"1234567891\",
\"address1\": \"No. 1 Road\",
\"address2\": \"Street 2\",
\"city\": \"Vancouver\",
\"province\": \"BC\",
\"country\": \"Canada\",
\"postal_code\": \"V6E 1B2\",
\"custom_id\": \"Internal456\"
}" \
"https://apigateway.payfirma.com/customer-service/customer/NV0B6eZB06"
Example Request Body:
{
'email': 'brandon@stark.com',
'first_name': 'Brandon',
'last_name': 'Stark',
'company': 'Payfirma',
'bcc_emails': 'john.snow@stark.com',
'telephone': '1234567891',
'address1': 'No. 1 Road',
'address2': 'Street 2',
'city': 'Vancouver',
'province': 'BC',
'country': 'Canada',
'postal_code': 'V6E 1B2',
'custom_id': 'Internal456',
}
Example Response Body:
{
'id': 2992429,
'lookup_id': 'NV0B6eZB06',
'email': 'brandon@stark.com',
'first_name': 'Brandon',
'last_name': 'Stark',
'company': 'Payfirma',
'bcc_emails': 'john.snow@stark.com',
'telephone': '1234567891',
'address1': 'No. 1 Road',
'address2': 'Street 2',
'city': 'Vancouver',
'province': 'BC',
'country': 'Canada',
'postal_code': 'V6E 1B2',
'custom_id': 'Internal456',
'cards':[{"id":123456,"lookup_id":"34cvb54564dfc","card_expiry":"01/20","card_prefix":"4111","card_suffix":"1111","is_default":true,"card_description":"test card"}],
'subscriptions':[{"id":123456,"lookup_id":"34cvb54564dfc","plan_id":987654,"plan_lookup_id":"98Avb98765dfc","name":"Sample Daily Plan","status":"ACTIVE","amount":10.99,"currency":"CAD","frequency":"DAILY","last_success":1467760023000,"last_run":1467760023000,"next_run":1467760023000,"total_cycles":10,"completed_cycles":3,"remaining_cycles":7,"failed_attempts":1,"delinquent_cycles":0,"delinquent_since":1467760023000}],
}
Card
Store a credit card with a customer profile and update the card object as needed.
BASE URI
https://apigateway.payfirma.com/customer-service
Add a new card
Store a new credit card to a customer profile.
HTTPS POST
/customer/{customer_lookup_id}/card
Example Request:
curl --include \
--request POST \
--header "Content-Type: application/json" \
--header "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJhY2Nlc3NfdG9rZW4iOiIxM2EyN2ViZS1iZTEwLTQzY2ItYjFmOC1lYjY4ZWEwOGFlNGIiLCJleHAiOjE0NTcwNTU0NjN9._KIfokRmM38MjP-q2pxB6Lk_-dcg2VnLg9QiuwksxKU" \
--data-binary "{
\"card_expiry_month\": 11,
\"card_expiry_year\": 16,
\"card_number\": \"4111111111111111\",
\"cvv2\": \"595\",
\"is_default\": true,
\"card_description\": \"test card\"
}" \
"https://apigateway.payfirma.com/customer-service/customer/NV0B6eZB06/card"
Example Request Body:
{
'card_expiry_month': 11,
'card_expiry_year': 16,
'card_number': '4111111111111111',
'cvv2': '595',
'is_default': true,
'card_description': 'test card',
}
Example Response Body:
{
'id': 2992429,
'lookup_id': 'NV0B6eZB06',
'email': 'brandon@stark.com',
'first_name': 'Brandon',
'last_name': 'Stark',
'company': 'Payfirma',
'bcc_emails': 'john.snow@stark.com',
'telephone': '1234567891',
'address1': 'No. 1 Road',
'address2': 'Street 2',
'city': 'Vancouver',
'province': 'BC',
'country': 'Canada',
'postal_code': 'V6E 1B2',
'custom_id': 'Internal456',
'cards':[{"id":123456,"lookup_id":"34cvb54564dfc","card_expiry":"01/20","card_prefix":"4111","card_suffix":"1111","is_default":true,"card_description":"test card"}],
'subscriptions':[{"id":123456,"lookup_id":"34cvb54564dfc","plan_id":987654,"plan_lookup_id":"98Avb98765dfc","name":"Sample Daily Plan","status":"ACTIVE","amount":10.99,"currency":"CAD","frequency":"DAILY","last_success":1467760023000,"last_run":1467760023000,"next_run":1467760023000,"total_cycles":10,"completed_cycles":3,"remaining_cycles":7,"failed_attempts":1,"delinquent_cycles":0,"delinquent_since":1467760023000}],
}
Update a card
Update an existing credit card object.
HTTPS PATCH
/customer/{customer_lookup_id}/card/{card_lookup_id}
Example Request:
curl --include \
--request PATCH \
--header "Content-Type: application/json" \
--header "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJhY2Nlc3NfdG9rZW4iOiIxM2EyN2ViZS1iZTEwLTQzY2ItYjFmOC1lYjY4ZWEwOGFlNGIiLCJleHAiOjE0NTcwNTU0NjN9._KIfokRmM38MjP-q2pxB6Lk_-dcg2VnLg9QiuwksxKU" \
--data-binary "{
\"is_default\": true,
\"card_description\": \"test card\"
}" \
"https://apigateway.payfirma.com/customer-service/customer/NV0B6eZB06/card/34cvb54564dfc"
Example Request Body:
{
'is_default': true,
'card_description': 'test card',
}
Example Response Body:
{
'id': 2992429,
'lookup_id': 'NV0B6eZB06',
'email': 'brandon@stark.com',
'first_name': 'Brandon',
'last_name': 'Stark',
'company': 'Payfirma',
'bcc_emails': 'john.snow@stark.com',
'telephone': '1234567891',
'address1': 'No. 1 Road',
'address2': 'Street 2',
'city': 'Vancouver',
'province': 'BC',
'country': 'Canada',
'postal_code': 'V6E 1B2',
'custom_id': 'Internal456',
'cards':[{"id":123456,"lookup_id":"34cvb54564dfc","card_expiry":"01/20","card_prefix":"4111","card_suffix":"1111","is_default":true,"card_description":"test card"}],
'subscriptions':[{"id":123456,"lookup_id":"34cvb54564dfc","plan_id":987654,"plan_lookup_id":"98Avb98765dfc","name":"Sample Daily Plan","status":"ACTIVE","amount":10.99,"currency":"CAD","frequency":"DAILY","last_success":1467760023000,"last_run":1467760023000,"next_run":1467760023000,"total_cycles":10,"completed_cycles":3,"remaining_cycles":7,"failed_attempts":1,"delinquent_cycles":0,"delinquent_since":1467760023000}],
}
Remove a card
Remove a credit card from a customer’s profile.
HTTPS DELETE
/customer/{customer_lookup_id}/card/{card_lookup_id}
Example Request:
curl --include \
--request DELETE \
--header "Content-Type: application/json" \
--header "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJhY2Nlc3NfdG9rZW4iOiIxM2EyN2ViZS1iZTEwLTQzY2ItYjFmOC1lYjY4ZWEwOGFlNGIiLCJleHAiOjE0NTcwNTU0NjN9._KIfokRmM38MjP-q2pxB6Lk_-dcg2VnLg9QiuwksxKU" \
"https://apigateway.payfirma.com/customer-service/customer/NV0B6eZB06/card/34cvb54564dfc"
Example Response Body:
{
'id': 2992429,
'lookup_id': 'NV0B6eZB06',
'email': 'brandon@stark.com',
'first_name': 'Brandon',
'last_name': 'Stark',
'company': 'Payfirma',
'bcc_emails': 'john.snow@stark.com',
'telephone': '1234567891',
'address1': 'No. 1 Road',
'address2': 'Street 2',
'city': 'Vancouver',
'province': 'BC',
'country': 'Canada',
'postal_code': 'V6E 1B2',
'custom_id': 'Internal456',
'cards':[{"id":123456,"lookup_id":"34cvb54564dfc","card_expiry":"01/20","card_prefix":"4111","card_suffix":"1111","is_default":true,"card_description":"test card"}],
'subscriptions':[{"id":123456,"lookup_id":"34cvb54564dfc","plan_id":987654,"plan_lookup_id":"98Avb98765dfc","name":"Sample Daily Plan","status":"ACTIVE","amount":10.99,"currency":"CAD","frequency":"DAILY","last_success":1467760023000,"last_run":1467760023000,"next_run":1467760023000,"total_cycles":10,"completed_cycles":3,"remaining_cycles":7,"failed_attempts":1,"delinquent_cycles":0,"delinquent_since":1467760023000}],
}
Subscription
Use stored customer profiles and cards to set up subscription payments based off your recurring plans
BASE URI
https://apigateway.payfirma.com/customer-service
Add a new subscription
Subscribe a given customer to a plan
HTTPS POST
/customer/subscription
Example Request:
curl --include \
--request POST \
--header "Content-Type: application/json" \
--header "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJhY2Nlc3NfdG9rZW4iOiIxM2EyN2ViZS1iZTEwLTQzY2ItYjFmOC1lYjY4ZWEwOGFlNGIiLCJleHAiOjE0NTcwNTU0NjN9._KIfokRmM38MjP-q2pxB6Lk_-dcg2VnLg9QiuwksxKU" \
--data-binary "{
\"plan_lookup_id\": \"99ffb59876mnb\",
\"card_lookup_id\": \"34cvb54564dfc\",
\"amount\": 10.99,
\"start_date\": 1467760023000,
\"email\": \"brandon@stark.com\",
\"bcc_emails\": \"nedd@stark.com, robb@stark.com\",
\"description\": \"My test plan\"
}" \
"https://apigateway.payfirma.com/customer-service/customer/NV0B6eZB06/subscription"
Example Request Body:
{
'plan_lookup_id': '99ffb59876mnb',
'card_lookup_id': '34cvb54564dfc',
'amount': 10.99,
'start_date': 1467760023000,
'email': 'brandon@stark.com',
'bcc_emails': 'nedd@stark.com, robb@stark.com',
'description': 'My test plan',
}
Example Response Body:
{
'id': 2992429,
'lookup_id': 'NV0B6eZB06',
'email': 'brandon@stark.com',
'first_name': 'Brandon',
'last_name': 'Stark',
'company': 'Payfirma',
'bcc_emails': 'john.snow@stark.com',
'telephone': '1234567891',
'address1': 'No. 1 Road',
'address2': 'Street 2',
'city': 'Vancouver',
'province': 'BC',
'country': 'Canada',
'postal_code': 'V6E 1B2',
'custom_id': 'Internal456',
'cards':[{"id":123456,"lookup_id":"34cvb54564dfc","card_expiry":"01/20","card_prefix":"4111","card_suffix":"1111","is_default":true,"card_description":"test card"}],
'subscriptions':[{"id":123456,"lookup_id":"34cvb54564dfc","plan_id":987654,"plan_lookup_id":"98Avb98765dfc","name":"Sample Daily Plan","status":"ACTIVE","amount":10.99,"currency":"CAD","frequency":"DAILY","last_success":1467760023000,"last_run":1467760023000,"next_run":1467760023000,"total_cycles":10,"completed_cycles":3,"remaining_cycles":7,"failed_attempts":1,"delinquent_cycles":0,"delinquent_since":1467760023000}],
}
Update a subscription
Update a subscription: Update the details of a subscription for a given customer lookup_id and a subscription lookup_id.
HTTPS PATCH
/customer/customerLookupId/subscription/subscriptionLookupId
Example Request:
curl --include \
--request PATCH \
--header "Content-Type: application/json" \
--header "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJhY2Nlc3NfdG9rZW4iOiIxM2EyN2ViZS1iZTEwLTQzY2ItYjFmOC1lYjY4ZWEwOGFlNGIiLCJleHAiOjE0NTcwNTU0NjN9._KIfokRmM38MjP-q2pxB6Lk_-dcg2VnLg9QiuwksxKU" \
--data-binary "{
\"card_lookup_id\": \"34cvb54564dfc\",
\"amount\": 10.99,
\"email\": \"brandon@stark.com\",
\"bcc_emails\": \"nedd@stark.com, robb@stark.com\",
\"description\": \"My test plan\"
}" \
"https://apigateway.payfirma.com/customer-service/customer/NV0B6eZB06/subscription/34cvb54564dfc"
Example Request Body:
{
'card_lookup_id': '34cvb54564dfc',
'amount': 10.99,
'status': 'PAUSED',
'email': 'brandon@stark.com',
'bcc_emails': 'nedd@stark.com, robb@stark.com',
'description': 'My test plan',
}
Example Response Body:
{
'id': 2992429,
'lookup_id': 'NV0B6eZB06',
'email': 'brandon@stark.com',
'first_name': 'Brandon',
'last_name': 'Stark',
'company': 'Payfirma',
'bcc_emails': 'john.snow@stark.com',
'telephone': '1234567891',
'address1': 'No. 1 Road',
'address2': 'Street 2',
'city': 'Vancouver',
'province': 'BC',
'country': 'Canada',
'postal_code': 'V6E 1B2',
'custom_id': 'Internal456',
'cards':[{"id":123456,"lookup_id":"34cvb54564dfc","card_expiry":"01/20","card_prefix":"4111","card_suffix":"1111","is_default":true,"card_description":"test card"}],
'subscriptions':[{"id":123456,"lookup_id":"34cvb54564dfc","plan_id":987654,"plan_lookup_id":"98Avb98765dfc","name":"Sample Daily Plan","status":"ACTIVE","amount":10.99,"currency":"CAD","frequency":"DAILY","last_success":1467760023000,"last_run":1467760023000,"next_run":1467760023000,"total_cycles":10,"completed_cycles":3,"remaining_cycles":7,"failed_attempts":1,"delinquent_cycles":0,"delinquent_since":1467760023000}],
}
Cancel a subscription
Cancel a subscription: Cancel all future payments scheduled on a subscription plan by changing the status of the subscription
HTTPS PATCH
/customer/customerLookupId/subscription/subscriptionLookupId
Example Request:
curl --include \
--request PATCH \
--header "Content-Type: application/json" \
--header "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJhY2Nlc3NfdG9rZW4iOiIxM2EyN2ViZS1iZTEwLTQzY2ItYjFmOC1lYjY4ZWEwOGFlNGIiLCJleHAiOjE0NTcwNTU0NjN9._KIfokRmM38MjP-q2pxB6Lk_-dcg2VnLg9QiuwksxKU" \
--data-binary "{
\"card_lookup_id\": \"34cvb54564dfc\",
\"amount\": 10.99,
\"email\": \"brandon@stark.com\",
\"bcc_emails\": \"nedd@stark.com, robb@stark.com\",
\"description\": \"My test plan\"
}" \
"https://apigateway.payfirma.com/customer-service/customer/NV0B6eZB06/subscription/34cvb54564dfc"
Example Request Body:
{
'status': 'CANCELLED',
}
Example Response Body:
{
'id': 2992429,
'lookup_id': 'NV0B6eZB06',
'email': 'brandon@stark.com',
'first_name': 'Brandon',
'last_name': 'Stark',
'company': 'Payfirma',
'bcc_emails': 'john.snow@stark.com',
'telephone': '1234567891',
'address1': 'No. 1 Road',
'address2': 'Street 2',
'city': 'Vancouver',
'province': 'BC',
'country': 'Canada',
'postal_code': 'V6E 1B2',
'custom_id': 'Internal456',
'cards':[{"id":123456,"lookup_id":"34cvb54564dfc","card_expiry":"01/20","card_prefix":"4111","card_suffix":"1111","is_default":true,"card_description":"test card"}],
'subscriptions':[{"id":123456,"lookup_id":"34cvb54564dfc","plan_id":987654,"plan_lookup_id":"98Avb98765dfc","name":"Sample Daily Plan","status":"ACTIVE","amount":10.99,"currency":"CAD","frequency":"DAILY","last_success":1467760023000,"last_run":1467760023000,"next_run":1467760023000,"total_cycles":10,"completed_cycles":3,"remaining_cycles":7,"failed_attempts":1,"delinquent_cycles":0,"delinquent_since":1467760023000}],
}