You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
type: objectproperties:
id:
description: The customer identifier stringreadOnly: trueallOf:
- $ref: ./ResourceId.yamlwebsiteId:
description: The website's IDallOf:
- $ref: ./ResourceId.yamlpaymentToken:
type: stringwriteOnly: truedescription: | A write-only payment token; if supplied, it will be converted into a payment instrument and be set as the `defaultPaymentInstrument`. The value of this property will override the `defaultPaymentInstrument` in the case that both are supplied. The token may only be used once before it is expired.defaultPaymentInstrument:
$ref: ./PaymentInstrument.yamlcreatedTime:
description: The customer created timeallOf:
- $ref: ./ServerTimestamp.yamlupdatedTime:
description: The customer updated timeallOf:
- $ref: ./ServerTimestamp.yamltags:
description: A list of customer's tagsreadOnly: truetype: arrayitems:
$ref: ./Tags/Tag.yamlrevision:
description: > The number of times the customer data has been modified. The revision is useful when analyzing webhook data to determine if the change takes precedence over the current representation.type: integerreadOnly: true_links:
type: arraydescription: The links related to resourcereadOnly: trueminItems: 3items:
anyOf:
- $ref: ./Links/SelfLink.yaml
- $ref: ./Links/NotesLink.yaml
- $ref: ./Links/DefaultPaymentInstrumentLink.yaml
- $ref: ./Links/LeadSourceLink.yaml
- $ref: ./Links/WebsiteLink.yaml_embedded:
type: arraydescription: >- Any embedded objects available that are requested by the `expand` querystring parameter.readOnly: trueminItems: 1items:
anyOf:
- $ref: ./Embeds/LeadSourceEmbed.yaml
get:
tags:
- Customerssummary: Retrieve a list of customersoperationId: GetCustomerCollectiondescription: | You can have a markdown description here.parameters:
- $ref: ../components/parameters/collectionLimit.yaml
- $ref: ../components/parameters/collectionOffset.yaml
- $ref: ../components/parameters/collectionFilter.yaml
- $ref: ../components/parameters/collectionQuery.yaml
- $ref: ../components/parameters/collectionExpand.yaml
- $ref: ../components/parameters/collectionFields.yamlresponses:
'200':
description: A list of Customers was retrieved successfullyheaders:
Rate-Limit-Limit:
$ref: ../components/headers/Rate-Limit-Limit.yamlRate-Limit-Remaining:
$ref: ../components/headers/Rate-Limit-Remaining.yamlRate-Limit-Reset:
$ref: ../components/headers/Rate-Limit-Reset.yamlPagination-Total:
$ref: ../components/headers/Pagination-Total.yamlPagination-Limit:
$ref: ../components/headers/Pagination-Limit.yamlPagination-Offset:
$ref: ../components/headers/Pagination-Offset.yamlcontent:
application/json:
schema:
type: arrayitems:
$ref: ../components/schemas/Customer.yamltext/csv:
schema:
type: arrayitems:
$ref: ../components/schemas/Customer.yaml'401':
$ref: ../components/responses/AccessForbidden.yamlx-code-samples:
- lang: PHPsource:
$ref: ../code_samples/PHP/customers/get.phppost:
tags:
- Customerssummary: Create a customer (without an ID)operationId: PostCustomerdescription: Another markdown description here.requestBody:
$ref: ../components/requestBodies/Customer.yamlresponses:
'201':
$ref: ../components/responses/Customer.yaml'401':
$ref: ../components/responses/AccessForbidden.yaml'409':
$ref: ../components/responses/Conflict.yaml'422':
$ref: ../components/responses/InvalidDataError.yamlx-code-samples:
- lang: PHPsource:
$ref: ../code_samples/PHP/customers/post.php