Create customer with default plan subscription
curl --request POST \
--url https://platform.runonatlas.com/external/customers \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"externalId": "external-customer-id-123",
"billingAddress1": "123 Main St",
"billingAddress2": "Apt 1",
"billingCity": "Anytown",
"billingCountry": "US",
"billingState": "CA",
"billingZipCode": "12345",
"shippingAddress1": "123 Main St",
"shippingAddress2": "Apt 1",
"shippingCity": "Anytown",
"shippingCountry": "US",
"shippingState": "CA",
"shippingZipCode": "12345",
"email": "john.doe@example.com",
"name": "John Doe",
"quickBooksId": "quickbooks-customer-id-123",
"stripeId": "stripe-customer-id-123",
"xeroId": "xero-customer-id-123"
}
'import requests
url = "https://platform.runonatlas.com/external/customers"
payload = {
"externalId": "external-customer-id-123",
"billingAddress1": "123 Main St",
"billingAddress2": "Apt 1",
"billingCity": "Anytown",
"billingCountry": "US",
"billingState": "CA",
"billingZipCode": "12345",
"shippingAddress1": "123 Main St",
"shippingAddress2": "Apt 1",
"shippingCity": "Anytown",
"shippingCountry": "US",
"shippingState": "CA",
"shippingZipCode": "12345",
"email": "john.doe@example.com",
"name": "John Doe",
"quickBooksId": "quickbooks-customer-id-123",
"stripeId": "stripe-customer-id-123",
"xeroId": "xero-customer-id-123"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
externalId: 'external-customer-id-123',
billingAddress1: '123 Main St',
billingAddress2: 'Apt 1',
billingCity: 'Anytown',
billingCountry: 'US',
billingState: 'CA',
billingZipCode: '12345',
shippingAddress1: '123 Main St',
shippingAddress2: 'Apt 1',
shippingCity: 'Anytown',
shippingCountry: 'US',
shippingState: 'CA',
shippingZipCode: '12345',
email: 'john.doe@example.com',
name: 'John Doe',
quickBooksId: 'quickbooks-customer-id-123',
stripeId: 'stripe-customer-id-123',
xeroId: 'xero-customer-id-123'
})
};
fetch('https://platform.runonatlas.com/external/customers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://platform.runonatlas.com/external/customers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'externalId' => 'external-customer-id-123',
'billingAddress1' => '123 Main St',
'billingAddress2' => 'Apt 1',
'billingCity' => 'Anytown',
'billingCountry' => 'US',
'billingState' => 'CA',
'billingZipCode' => '12345',
'shippingAddress1' => '123 Main St',
'shippingAddress2' => 'Apt 1',
'shippingCity' => 'Anytown',
'shippingCountry' => 'US',
'shippingState' => 'CA',
'shippingZipCode' => '12345',
'email' => 'john.doe@example.com',
'name' => 'John Doe',
'quickBooksId' => 'quickbooks-customer-id-123',
'stripeId' => 'stripe-customer-id-123',
'xeroId' => 'xero-customer-id-123'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://platform.runonatlas.com/external/customers"
payload := strings.NewReader("{\n \"externalId\": \"external-customer-id-123\",\n \"billingAddress1\": \"123 Main St\",\n \"billingAddress2\": \"Apt 1\",\n \"billingCity\": \"Anytown\",\n \"billingCountry\": \"US\",\n \"billingState\": \"CA\",\n \"billingZipCode\": \"12345\",\n \"shippingAddress1\": \"123 Main St\",\n \"shippingAddress2\": \"Apt 1\",\n \"shippingCity\": \"Anytown\",\n \"shippingCountry\": \"US\",\n \"shippingState\": \"CA\",\n \"shippingZipCode\": \"12345\",\n \"email\": \"john.doe@example.com\",\n \"name\": \"John Doe\",\n \"quickBooksId\": \"quickbooks-customer-id-123\",\n \"stripeId\": \"stripe-customer-id-123\",\n \"xeroId\": \"xero-customer-id-123\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://platform.runonatlas.com/external/customers")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"externalId\": \"external-customer-id-123\",\n \"billingAddress1\": \"123 Main St\",\n \"billingAddress2\": \"Apt 1\",\n \"billingCity\": \"Anytown\",\n \"billingCountry\": \"US\",\n \"billingState\": \"CA\",\n \"billingZipCode\": \"12345\",\n \"shippingAddress1\": \"123 Main St\",\n \"shippingAddress2\": \"Apt 1\",\n \"shippingCity\": \"Anytown\",\n \"shippingCountry\": \"US\",\n \"shippingState\": \"CA\",\n \"shippingZipCode\": \"12345\",\n \"email\": \"john.doe@example.com\",\n \"name\": \"John Doe\",\n \"quickBooksId\": \"quickbooks-customer-id-123\",\n \"stripeId\": \"stripe-customer-id-123\",\n \"xeroId\": \"xero-customer-id-123\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.runonatlas.com/external/customers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"externalId\": \"external-customer-id-123\",\n \"billingAddress1\": \"123 Main St\",\n \"billingAddress2\": \"Apt 1\",\n \"billingCity\": \"Anytown\",\n \"billingCountry\": \"US\",\n \"billingState\": \"CA\",\n \"billingZipCode\": \"12345\",\n \"shippingAddress1\": \"123 Main St\",\n \"shippingAddress2\": \"Apt 1\",\n \"shippingCity\": \"Anytown\",\n \"shippingCountry\": \"US\",\n \"shippingState\": \"CA\",\n \"shippingZipCode\": \"12345\",\n \"email\": \"john.doe@example.com\",\n \"name\": \"John Doe\",\n \"quickBooksId\": \"quickbooks-customer-id-123\",\n \"stripeId\": \"stripe-customer-id-123\",\n \"xeroId\": \"xero-customer-id-123\"\n}"
response = http.request(request)
puts response.read_body{
"createdAt": "2021-01-01T00:00:00.000Z",
"id": "atlas-internal-customer-id-123",
"updatedAt": "2021-01-01T00:00:00.000Z",
"merchantId": "atlas-internal-merchant-id-123",
"subscriptions": [
{
"createdAt": "2021-01-01T00:00:00.000Z",
"id": "atlas-internal-subscription-id-123",
"startDate": "2021-01-01T00:00:00.000Z",
"status": "active",
"updatedAt": "2021-01-01T00:00:00.000Z",
"allowCustomerChanges": true,
"autoChargeInvoice": false,
"autoSyncInvoice": true,
"autoSendInvoice": true,
"paymentGateway": "Stripe",
"isTrial": false,
"customerId": "atlas-internal-customer-id-123",
"planId": "atlas-internal-plan-id-123",
"merchantId": "atlas-internal-merchant-id-123",
"plan": {
"createdAt": "2021-01-01T00:00:00.000Z",
"crossEnvironmentId": "plan-cross-env-id-123",
"currency": "USD",
"description": "A great plan for your needs",
"id": "atlas-internal-plan-id-123",
"isPrivate": false,
"name": "Pro",
"netTerms": "net30",
"purchasable": true,
"requestPricingText": "Contact us for pricing",
"requestPricingUrl": "https://example.com/request-pricing",
"status": "available",
"updatedAt": "2021-01-01T00:00:00.000Z",
"merchantId": "atlas-internal-merchant-id-123",
"externalId": "external-plan-id-123",
"basePlanPriceId": "atlas-internal-price-id-123",
"basePlanPriceQuarterlyId": "atlas-internal-price-id-123",
"basePlanPriceAnnuallyId": "atlas-internal-price-id-123",
"basePlanPriceMonthlyStatus": "active",
"basePlanPriceQuarterlyStatus": "active",
"basePlanPriceAnnuallyStatus": "active",
"basePlanPrice": {
"billingCadence": "monthly",
"billingMode": "advance",
"blockOverage": false,
"createdAt": "2021-01-01T00:00:00.000Z",
"entityType": "entitlement",
"id": "atlas-internal-price-id-123",
"name": "Pro Price",
"priceType": "unit",
"rules": {
"quantity": 1,
"price": 10
},
"status": "active",
"usesCustomPricingUnit": false,
"billableId": "atlas-internal-billable-id-123",
"merchantId": "atlas-internal-merchant-id-123",
"limit": 100,
"maxUsage": 1000,
"customPricingUnitId": "atlas-internal-custom-pricing-unit-id-123"
}
},
"billingCadence": "monthly",
"currency": "USD",
"endDate": "2021-12-31T00:00:00.000Z",
"netTerms": "net30",
"chargeForUsageBasedPricesDuringTrial": false
}
],
"activeSubscriptions": [
{
"createdAt": "2021-01-01T00:00:00.000Z",
"id": "atlas-internal-subscription-id-123",
"startDate": "2021-01-01T00:00:00.000Z",
"status": "active",
"updatedAt": "2021-01-01T00:00:00.000Z",
"allowCustomerChanges": true,
"autoChargeInvoice": false,
"autoSyncInvoice": true,
"autoSendInvoice": true,
"paymentGateway": "Stripe",
"isTrial": false,
"customerId": "atlas-internal-customer-id-123",
"planId": "atlas-internal-plan-id-123",
"merchantId": "atlas-internal-merchant-id-123",
"plan": {
"createdAt": "2021-01-01T00:00:00.000Z",
"crossEnvironmentId": "plan-cross-env-id-123",
"currency": "USD",
"description": "A great plan for your needs",
"id": "atlas-internal-plan-id-123",
"isPrivate": false,
"name": "Pro",
"netTerms": "net30",
"purchasable": true,
"requestPricingText": "Contact us for pricing",
"requestPricingUrl": "https://example.com/request-pricing",
"status": "available",
"updatedAt": "2021-01-01T00:00:00.000Z",
"merchantId": "atlas-internal-merchant-id-123",
"externalId": "external-plan-id-123",
"basePlanPriceId": "atlas-internal-price-id-123",
"basePlanPriceQuarterlyId": "atlas-internal-price-id-123",
"basePlanPriceAnnuallyId": "atlas-internal-price-id-123",
"basePlanPriceMonthlyStatus": "active",
"basePlanPriceQuarterlyStatus": "active",
"basePlanPriceAnnuallyStatus": "active",
"basePlanPrice": {
"billingCadence": "monthly",
"billingMode": "advance",
"blockOverage": false,
"createdAt": "2021-01-01T00:00:00.000Z",
"entityType": "entitlement",
"id": "atlas-internal-price-id-123",
"name": "Pro Price",
"priceType": "unit",
"rules": {
"quantity": 1,
"price": 10
},
"status": "active",
"usesCustomPricingUnit": false,
"billableId": "atlas-internal-billable-id-123",
"merchantId": "atlas-internal-merchant-id-123",
"limit": 100,
"maxUsage": 1000,
"customPricingUnitId": "atlas-internal-custom-pricing-unit-id-123"
}
},
"billingCadence": "monthly",
"currency": "USD",
"endDate": "2021-12-31T00:00:00.000Z",
"netTerms": "net30",
"chargeForUsageBasedPricesDuringTrial": false
}
],
"upcomingSubscriptions": [
{
"createdAt": "2021-01-01T00:00:00.000Z",
"id": "atlas-internal-subscription-id-123",
"startDate": "2021-01-01T00:00:00.000Z",
"status": "active",
"updatedAt": "2021-01-01T00:00:00.000Z",
"allowCustomerChanges": true,
"autoChargeInvoice": false,
"autoSyncInvoice": true,
"autoSendInvoice": true,
"paymentGateway": "Stripe",
"isTrial": false,
"customerId": "atlas-internal-customer-id-123",
"planId": "atlas-internal-plan-id-123",
"merchantId": "atlas-internal-merchant-id-123",
"plan": {
"createdAt": "2021-01-01T00:00:00.000Z",
"crossEnvironmentId": "plan-cross-env-id-123",
"currency": "USD",
"description": "A great plan for your needs",
"id": "atlas-internal-plan-id-123",
"isPrivate": false,
"name": "Pro",
"netTerms": "net30",
"purchasable": true,
"requestPricingText": "Contact us for pricing",
"requestPricingUrl": "https://example.com/request-pricing",
"status": "available",
"updatedAt": "2021-01-01T00:00:00.000Z",
"merchantId": "atlas-internal-merchant-id-123",
"externalId": "external-plan-id-123",
"basePlanPriceId": "atlas-internal-price-id-123",
"basePlanPriceQuarterlyId": "atlas-internal-price-id-123",
"basePlanPriceAnnuallyId": "atlas-internal-price-id-123",
"basePlanPriceMonthlyStatus": "active",
"basePlanPriceQuarterlyStatus": "active",
"basePlanPriceAnnuallyStatus": "active",
"basePlanPrice": {
"billingCadence": "monthly",
"billingMode": "advance",
"blockOverage": false,
"createdAt": "2021-01-01T00:00:00.000Z",
"entityType": "entitlement",
"id": "atlas-internal-price-id-123",
"name": "Pro Price",
"priceType": "unit",
"rules": {
"quantity": 1,
"price": 10
},
"status": "active",
"usesCustomPricingUnit": false,
"billableId": "atlas-internal-billable-id-123",
"merchantId": "atlas-internal-merchant-id-123",
"limit": 100,
"maxUsage": 1000,
"customPricingUnitId": "atlas-internal-custom-pricing-unit-id-123"
}
},
"billingCadence": "monthly",
"currency": "USD",
"endDate": "2021-12-31T00:00:00.000Z",
"netTerms": "net30",
"chargeForUsageBasedPricesDuringTrial": false
}
],
"conditionalBillableAccess": [
{
"access": true,
"createdAt": "2021-01-01T00:00:00.000Z",
"endDate": "2021-12-31T00:00:00.000Z",
"id": "atlas-internal-conditional-billable-access-id-123",
"invalidated": false,
"startDate": "2021-01-01T00:00:00.000Z",
"updatedAt": "2021-01-01T00:00:00.000Z",
"billableId": "atlas-internal-billable-id-123",
"customerId": "atlas-internal-customer-id-123",
"merchantId": "atlas-internal-merchant-id-123",
"subscriptionId": "atlas-internal-subscription-id-123",
"currentUsage": 50
}
],
"customPricingUnits": [
{
"customPricingUnitId": "atlas-internal-custom-pricing-unit-id-123",
"balance": 100
}
],
"customerPrivatePlans": [
{
"planId": "atlas-internal-plan-id-123"
}
],
"isEligibleForTrial": true,
"billingAddress1": "123 Main St",
"billingAddress2": "Apt 1",
"billingCity": "Anytown",
"billingCountry": "US",
"billingState": "CA",
"billingZipCode": "12345",
"shippingAddress1": "123 Main St",
"shippingAddress2": "Apt 1",
"shippingCity": "Anytown",
"shippingCountry": "US",
"shippingState": "CA",
"shippingZipCode": "12345",
"email": "john.doe@example.com",
"externalId": "external-customer-id-123",
"name": "John Doe",
"quickBooksId": "quickbooks-customer-id-123",
"stripeId": "stripe-customer-id-123"
}Customers
Create customer with default plan subscription
Create a new customer with a unique external ID (e.g. the customer ID in your system). Also automatically subscribes the customer to the default plan if eligible.
POST
/
external
/
customers
Create customer with default plan subscription
curl --request POST \
--url https://platform.runonatlas.com/external/customers \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"externalId": "external-customer-id-123",
"billingAddress1": "123 Main St",
"billingAddress2": "Apt 1",
"billingCity": "Anytown",
"billingCountry": "US",
"billingState": "CA",
"billingZipCode": "12345",
"shippingAddress1": "123 Main St",
"shippingAddress2": "Apt 1",
"shippingCity": "Anytown",
"shippingCountry": "US",
"shippingState": "CA",
"shippingZipCode": "12345",
"email": "john.doe@example.com",
"name": "John Doe",
"quickBooksId": "quickbooks-customer-id-123",
"stripeId": "stripe-customer-id-123",
"xeroId": "xero-customer-id-123"
}
'import requests
url = "https://platform.runonatlas.com/external/customers"
payload = {
"externalId": "external-customer-id-123",
"billingAddress1": "123 Main St",
"billingAddress2": "Apt 1",
"billingCity": "Anytown",
"billingCountry": "US",
"billingState": "CA",
"billingZipCode": "12345",
"shippingAddress1": "123 Main St",
"shippingAddress2": "Apt 1",
"shippingCity": "Anytown",
"shippingCountry": "US",
"shippingState": "CA",
"shippingZipCode": "12345",
"email": "john.doe@example.com",
"name": "John Doe",
"quickBooksId": "quickbooks-customer-id-123",
"stripeId": "stripe-customer-id-123",
"xeroId": "xero-customer-id-123"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
externalId: 'external-customer-id-123',
billingAddress1: '123 Main St',
billingAddress2: 'Apt 1',
billingCity: 'Anytown',
billingCountry: 'US',
billingState: 'CA',
billingZipCode: '12345',
shippingAddress1: '123 Main St',
shippingAddress2: 'Apt 1',
shippingCity: 'Anytown',
shippingCountry: 'US',
shippingState: 'CA',
shippingZipCode: '12345',
email: 'john.doe@example.com',
name: 'John Doe',
quickBooksId: 'quickbooks-customer-id-123',
stripeId: 'stripe-customer-id-123',
xeroId: 'xero-customer-id-123'
})
};
fetch('https://platform.runonatlas.com/external/customers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://platform.runonatlas.com/external/customers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'externalId' => 'external-customer-id-123',
'billingAddress1' => '123 Main St',
'billingAddress2' => 'Apt 1',
'billingCity' => 'Anytown',
'billingCountry' => 'US',
'billingState' => 'CA',
'billingZipCode' => '12345',
'shippingAddress1' => '123 Main St',
'shippingAddress2' => 'Apt 1',
'shippingCity' => 'Anytown',
'shippingCountry' => 'US',
'shippingState' => 'CA',
'shippingZipCode' => '12345',
'email' => 'john.doe@example.com',
'name' => 'John Doe',
'quickBooksId' => 'quickbooks-customer-id-123',
'stripeId' => 'stripe-customer-id-123',
'xeroId' => 'xero-customer-id-123'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://platform.runonatlas.com/external/customers"
payload := strings.NewReader("{\n \"externalId\": \"external-customer-id-123\",\n \"billingAddress1\": \"123 Main St\",\n \"billingAddress2\": \"Apt 1\",\n \"billingCity\": \"Anytown\",\n \"billingCountry\": \"US\",\n \"billingState\": \"CA\",\n \"billingZipCode\": \"12345\",\n \"shippingAddress1\": \"123 Main St\",\n \"shippingAddress2\": \"Apt 1\",\n \"shippingCity\": \"Anytown\",\n \"shippingCountry\": \"US\",\n \"shippingState\": \"CA\",\n \"shippingZipCode\": \"12345\",\n \"email\": \"john.doe@example.com\",\n \"name\": \"John Doe\",\n \"quickBooksId\": \"quickbooks-customer-id-123\",\n \"stripeId\": \"stripe-customer-id-123\",\n \"xeroId\": \"xero-customer-id-123\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://platform.runonatlas.com/external/customers")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"externalId\": \"external-customer-id-123\",\n \"billingAddress1\": \"123 Main St\",\n \"billingAddress2\": \"Apt 1\",\n \"billingCity\": \"Anytown\",\n \"billingCountry\": \"US\",\n \"billingState\": \"CA\",\n \"billingZipCode\": \"12345\",\n \"shippingAddress1\": \"123 Main St\",\n \"shippingAddress2\": \"Apt 1\",\n \"shippingCity\": \"Anytown\",\n \"shippingCountry\": \"US\",\n \"shippingState\": \"CA\",\n \"shippingZipCode\": \"12345\",\n \"email\": \"john.doe@example.com\",\n \"name\": \"John Doe\",\n \"quickBooksId\": \"quickbooks-customer-id-123\",\n \"stripeId\": \"stripe-customer-id-123\",\n \"xeroId\": \"xero-customer-id-123\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.runonatlas.com/external/customers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"externalId\": \"external-customer-id-123\",\n \"billingAddress1\": \"123 Main St\",\n \"billingAddress2\": \"Apt 1\",\n \"billingCity\": \"Anytown\",\n \"billingCountry\": \"US\",\n \"billingState\": \"CA\",\n \"billingZipCode\": \"12345\",\n \"shippingAddress1\": \"123 Main St\",\n \"shippingAddress2\": \"Apt 1\",\n \"shippingCity\": \"Anytown\",\n \"shippingCountry\": \"US\",\n \"shippingState\": \"CA\",\n \"shippingZipCode\": \"12345\",\n \"email\": \"john.doe@example.com\",\n \"name\": \"John Doe\",\n \"quickBooksId\": \"quickbooks-customer-id-123\",\n \"stripeId\": \"stripe-customer-id-123\",\n \"xeroId\": \"xero-customer-id-123\"\n}"
response = http.request(request)
puts response.read_body{
"createdAt": "2021-01-01T00:00:00.000Z",
"id": "atlas-internal-customer-id-123",
"updatedAt": "2021-01-01T00:00:00.000Z",
"merchantId": "atlas-internal-merchant-id-123",
"subscriptions": [
{
"createdAt": "2021-01-01T00:00:00.000Z",
"id": "atlas-internal-subscription-id-123",
"startDate": "2021-01-01T00:00:00.000Z",
"status": "active",
"updatedAt": "2021-01-01T00:00:00.000Z",
"allowCustomerChanges": true,
"autoChargeInvoice": false,
"autoSyncInvoice": true,
"autoSendInvoice": true,
"paymentGateway": "Stripe",
"isTrial": false,
"customerId": "atlas-internal-customer-id-123",
"planId": "atlas-internal-plan-id-123",
"merchantId": "atlas-internal-merchant-id-123",
"plan": {
"createdAt": "2021-01-01T00:00:00.000Z",
"crossEnvironmentId": "plan-cross-env-id-123",
"currency": "USD",
"description": "A great plan for your needs",
"id": "atlas-internal-plan-id-123",
"isPrivate": false,
"name": "Pro",
"netTerms": "net30",
"purchasable": true,
"requestPricingText": "Contact us for pricing",
"requestPricingUrl": "https://example.com/request-pricing",
"status": "available",
"updatedAt": "2021-01-01T00:00:00.000Z",
"merchantId": "atlas-internal-merchant-id-123",
"externalId": "external-plan-id-123",
"basePlanPriceId": "atlas-internal-price-id-123",
"basePlanPriceQuarterlyId": "atlas-internal-price-id-123",
"basePlanPriceAnnuallyId": "atlas-internal-price-id-123",
"basePlanPriceMonthlyStatus": "active",
"basePlanPriceQuarterlyStatus": "active",
"basePlanPriceAnnuallyStatus": "active",
"basePlanPrice": {
"billingCadence": "monthly",
"billingMode": "advance",
"blockOverage": false,
"createdAt": "2021-01-01T00:00:00.000Z",
"entityType": "entitlement",
"id": "atlas-internal-price-id-123",
"name": "Pro Price",
"priceType": "unit",
"rules": {
"quantity": 1,
"price": 10
},
"status": "active",
"usesCustomPricingUnit": false,
"billableId": "atlas-internal-billable-id-123",
"merchantId": "atlas-internal-merchant-id-123",
"limit": 100,
"maxUsage": 1000,
"customPricingUnitId": "atlas-internal-custom-pricing-unit-id-123"
}
},
"billingCadence": "monthly",
"currency": "USD",
"endDate": "2021-12-31T00:00:00.000Z",
"netTerms": "net30",
"chargeForUsageBasedPricesDuringTrial": false
}
],
"activeSubscriptions": [
{
"createdAt": "2021-01-01T00:00:00.000Z",
"id": "atlas-internal-subscription-id-123",
"startDate": "2021-01-01T00:00:00.000Z",
"status": "active",
"updatedAt": "2021-01-01T00:00:00.000Z",
"allowCustomerChanges": true,
"autoChargeInvoice": false,
"autoSyncInvoice": true,
"autoSendInvoice": true,
"paymentGateway": "Stripe",
"isTrial": false,
"customerId": "atlas-internal-customer-id-123",
"planId": "atlas-internal-plan-id-123",
"merchantId": "atlas-internal-merchant-id-123",
"plan": {
"createdAt": "2021-01-01T00:00:00.000Z",
"crossEnvironmentId": "plan-cross-env-id-123",
"currency": "USD",
"description": "A great plan for your needs",
"id": "atlas-internal-plan-id-123",
"isPrivate": false,
"name": "Pro",
"netTerms": "net30",
"purchasable": true,
"requestPricingText": "Contact us for pricing",
"requestPricingUrl": "https://example.com/request-pricing",
"status": "available",
"updatedAt": "2021-01-01T00:00:00.000Z",
"merchantId": "atlas-internal-merchant-id-123",
"externalId": "external-plan-id-123",
"basePlanPriceId": "atlas-internal-price-id-123",
"basePlanPriceQuarterlyId": "atlas-internal-price-id-123",
"basePlanPriceAnnuallyId": "atlas-internal-price-id-123",
"basePlanPriceMonthlyStatus": "active",
"basePlanPriceQuarterlyStatus": "active",
"basePlanPriceAnnuallyStatus": "active",
"basePlanPrice": {
"billingCadence": "monthly",
"billingMode": "advance",
"blockOverage": false,
"createdAt": "2021-01-01T00:00:00.000Z",
"entityType": "entitlement",
"id": "atlas-internal-price-id-123",
"name": "Pro Price",
"priceType": "unit",
"rules": {
"quantity": 1,
"price": 10
},
"status": "active",
"usesCustomPricingUnit": false,
"billableId": "atlas-internal-billable-id-123",
"merchantId": "atlas-internal-merchant-id-123",
"limit": 100,
"maxUsage": 1000,
"customPricingUnitId": "atlas-internal-custom-pricing-unit-id-123"
}
},
"billingCadence": "monthly",
"currency": "USD",
"endDate": "2021-12-31T00:00:00.000Z",
"netTerms": "net30",
"chargeForUsageBasedPricesDuringTrial": false
}
],
"upcomingSubscriptions": [
{
"createdAt": "2021-01-01T00:00:00.000Z",
"id": "atlas-internal-subscription-id-123",
"startDate": "2021-01-01T00:00:00.000Z",
"status": "active",
"updatedAt": "2021-01-01T00:00:00.000Z",
"allowCustomerChanges": true,
"autoChargeInvoice": false,
"autoSyncInvoice": true,
"autoSendInvoice": true,
"paymentGateway": "Stripe",
"isTrial": false,
"customerId": "atlas-internal-customer-id-123",
"planId": "atlas-internal-plan-id-123",
"merchantId": "atlas-internal-merchant-id-123",
"plan": {
"createdAt": "2021-01-01T00:00:00.000Z",
"crossEnvironmentId": "plan-cross-env-id-123",
"currency": "USD",
"description": "A great plan for your needs",
"id": "atlas-internal-plan-id-123",
"isPrivate": false,
"name": "Pro",
"netTerms": "net30",
"purchasable": true,
"requestPricingText": "Contact us for pricing",
"requestPricingUrl": "https://example.com/request-pricing",
"status": "available",
"updatedAt": "2021-01-01T00:00:00.000Z",
"merchantId": "atlas-internal-merchant-id-123",
"externalId": "external-plan-id-123",
"basePlanPriceId": "atlas-internal-price-id-123",
"basePlanPriceQuarterlyId": "atlas-internal-price-id-123",
"basePlanPriceAnnuallyId": "atlas-internal-price-id-123",
"basePlanPriceMonthlyStatus": "active",
"basePlanPriceQuarterlyStatus": "active",
"basePlanPriceAnnuallyStatus": "active",
"basePlanPrice": {
"billingCadence": "monthly",
"billingMode": "advance",
"blockOverage": false,
"createdAt": "2021-01-01T00:00:00.000Z",
"entityType": "entitlement",
"id": "atlas-internal-price-id-123",
"name": "Pro Price",
"priceType": "unit",
"rules": {
"quantity": 1,
"price": 10
},
"status": "active",
"usesCustomPricingUnit": false,
"billableId": "atlas-internal-billable-id-123",
"merchantId": "atlas-internal-merchant-id-123",
"limit": 100,
"maxUsage": 1000,
"customPricingUnitId": "atlas-internal-custom-pricing-unit-id-123"
}
},
"billingCadence": "monthly",
"currency": "USD",
"endDate": "2021-12-31T00:00:00.000Z",
"netTerms": "net30",
"chargeForUsageBasedPricesDuringTrial": false
}
],
"conditionalBillableAccess": [
{
"access": true,
"createdAt": "2021-01-01T00:00:00.000Z",
"endDate": "2021-12-31T00:00:00.000Z",
"id": "atlas-internal-conditional-billable-access-id-123",
"invalidated": false,
"startDate": "2021-01-01T00:00:00.000Z",
"updatedAt": "2021-01-01T00:00:00.000Z",
"billableId": "atlas-internal-billable-id-123",
"customerId": "atlas-internal-customer-id-123",
"merchantId": "atlas-internal-merchant-id-123",
"subscriptionId": "atlas-internal-subscription-id-123",
"currentUsage": 50
}
],
"customPricingUnits": [
{
"customPricingUnitId": "atlas-internal-custom-pricing-unit-id-123",
"balance": 100
}
],
"customerPrivatePlans": [
{
"planId": "atlas-internal-plan-id-123"
}
],
"isEligibleForTrial": true,
"billingAddress1": "123 Main St",
"billingAddress2": "Apt 1",
"billingCity": "Anytown",
"billingCountry": "US",
"billingState": "CA",
"billingZipCode": "12345",
"shippingAddress1": "123 Main St",
"shippingAddress2": "Apt 1",
"shippingCity": "Anytown",
"shippingCountry": "US",
"shippingState": "CA",
"shippingZipCode": "12345",
"email": "john.doe@example.com",
"externalId": "external-customer-id-123",
"name": "John Doe",
"quickBooksId": "quickbooks-customer-id-123",
"stripeId": "stripe-customer-id-123"
}Authorizations
You can obtain this key from the Atlas dashboard. It must be of type secret
Body
application/json
The external ID of the customer (e.g. the customer ID in your system)
Minimum string length:
1Example:
"external-customer-id-123"
Billing address line 1
Minimum string length:
1Example:
"123 Main St"
Billing address line 2
Minimum string length:
1Example:
"Apt 1"
Billing city
Minimum string length:
1Example:
"Anytown"
Billing country
Minimum string length:
1Example:
"US"
Billing state
Minimum string length:
1Example:
"CA"
Billing zip code. Must be 5 digits or 5+4 format.
Pattern:
^\d{5}(-\d{4})?$Example:
"12345"
Shipping address line 1
Minimum string length:
1Example:
"123 Main St"
Shipping address line 2
Minimum string length:
1Example:
"Apt 1"
Shipping city
Minimum string length:
1Example:
"Anytown"
Shipping country
Minimum string length:
1Example:
"US"
Shipping state
Minimum string length:
1Example:
"CA"
Shipping zip code. Must be 5 digits or 5+4 format.
Pattern:
^\d{5}(-\d{4})?$Example:
"12345"
The email of the customer
Minimum string length:
1Example:
"john.doe@example.com"
The name of the customer
Minimum string length:
1Example:
"John Doe"
The QuickBooks ID of the customer
Minimum string length:
1Example:
"quickbooks-customer-id-123"
The Stripe ID of the customer
Minimum string length:
1Example:
"stripe-customer-id-123"
The Xero ID of the customer
Minimum string length:
1Example:
"xero-customer-id-123"
Response
The customer that has been created.
The date and time the customer was created
Example:
"2021-01-01T00:00:00.000Z"
The Atlas customer ID
Minimum string length:
1Example:
"atlas-internal-customer-id-123"
The date and time the customer was last updated
Example:
"2021-01-01T00:00:00.000Z"
The Atlas merchant ID
Minimum string length:
1Example:
"atlas-internal-merchant-id-123"
The subscriptions associated with the customer
Show child attributes
Show child attributes
The active subscriptions associated with the customer
Show child attributes
Show child attributes
The upcoming subscriptions associated with the customer
Show child attributes
Show child attributes
The conditional billable access associated with the customer
Show child attributes
Show child attributes
The custom pricing units associated with the customer
Show child attributes
Show child attributes
The private plans associated with the customer
Show child attributes
Show child attributes
Whether the customer is eligible for a trial subscription. Only returns true if the customer has no previous or current paid or trial subscriptions.
Example:
true
Billing address line 1
Minimum string length:
1Example:
"123 Main St"
Billing address line 2
Minimum string length:
1Example:
"Apt 1"
Billing city
Minimum string length:
1Example:
"Anytown"
Billing country
Minimum string length:
1Example:
"US"
Billing state
Minimum string length:
1Example:
"CA"
Billing zip code. Must be 5 digits or 5+4 format.
Pattern:
^\d{5}(-\d{4})?$Example:
"12345"
Shipping address line 1
Minimum string length:
1Example:
"123 Main St"
Shipping address line 2
Minimum string length:
1Example:
"Apt 1"
Shipping city
Minimum string length:
1Example:
"Anytown"
Shipping country
Minimum string length:
1Example:
"US"
Shipping state
Minimum string length:
1Example:
"CA"
Shipping zip code. Must be 5 digits or 5+4 format.
Pattern:
^\d{5}(-\d{4})?$Example:
"12345"
The email of the customer
Minimum string length:
1Example:
"john.doe@example.com"
The external ID of the customer (e.g. the customer ID in your system)
Minimum string length:
1Example:
"external-customer-id-123"
The name of the customer
Minimum string length:
1Example:
"John Doe"
The QuickBooks ID of the customer
Minimum string length:
1Example:
"quickbooks-customer-id-123"
The Stripe ID of the customer
Minimum string length:
1Example:
"stripe-customer-id-123"