Afterpay Billing Agreements API (Deprecated) is one of 12 APIs that Cash App publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Billing Agreements, Deprecated, and Afterpay. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.
This API exposes
11 operations
across 10 paths,
and defines 53 schemas.
It is described by OpenAPI 3.1.0, at version 1.0.0.
Requests are made against 2 base URLs: https://global-api-sandbox.afterpay.com, https://global-api.afterpay.com.
The identity and technical contract details declared by the specification.
Consumer
object
The consumer data model is used for gathering essential user information. It captures details such as the individual's first name, represented by givenNames, a…
4 properties
1 required
BillingAgreementApprovalRequestMerchant
object
4 properties
2 required
AgreementApprovalType
string
Agreement Type for approval.
AgreementApproval
object
Details about the agreement to be created.
2 properties
1 required
BillingAgreementApprovalRequest
object
Request body for initiating a billing agreement approval process
4 properties
1 required
BillingAgreementApprovalResponse
object
Response from initiating a billing agreement approval process
3 properties
3 required
CreateAgreementRequest
object
3 properties
1 required
BillingAgreementResponseType
string
Type of agreement
BillingAgreementResponseStatus
string
Current status of the agreement
AgreementEventResponseType
string
Type of event
Money
object
Object containing amount and currency
2 properties
2 required
AgreementEventResponseStatus
string
Status of the agreement at the time of the event
AgreementEventResponse
object
Response type for agreement events
6 properties
BillingAgreementResponse
object
Response type for billing agreements
11 properties
4 required
BillingAgreementAliasRequest
object
Request to create an alias for a billing agreement
2 properties
1 required
BillingAgreementAliasResponse
object
Response containing the payment schedule token and its expiry
2 properties
2 required
CancelBillingAgreementRequest
object
Request to cancel a billing agreement
1 property
1 required
OffersRequest
object
Request to retrieve available billing agreement offers
3 properties
3 required
OfferType
string
Type of the offer
PaymentSchedule
object
Represents a scheduled payment installment
2 properties
2 required
ConsumerOffersNoPaymentUpfront
object
Information about the no payment upfront feature eligibility
2 properties
2 required
ConsumerOffers
object
Consumer offers
1 property
Offer
object
Represents an offer with payment details
8 properties
OffersResponse
object
Response containing available offers for the consumer
3 properties
GetBillingAgreementRequest
object
Request to retrieve a billing agreement by token
1 property
1 required
LinkStartRequest
object
Request to start a billing agreement link flow
2 properties
2 required
LinkStartResponseDeliveryType
string
How the verification code was delivered to the consumer
LinkStartResponse
object
Response containing the billing agreement link details
4 properties
4 required
RecurringPaymentRequestPaymentMethodType
string
The payment method type
RecurringPaymentRequestPaymentMethod
object
2 properties
2 required
ContactCountryCode
string
Contact
object
This data model is used for storing an individual's contact information. Mandatory fields such as name, line1, area1, region, postcode, and countryCode help in…
9 properties
6 required
ShippingCourierPriority
string
Shipping-Courier
object
Essential information for tracking a shipment. The shippedAt key represents the date and time when the item was shipped. This value follows the [ISO 8601 stand…
4 properties
Item
object
This data model is used to store crucial product details. The price.amount field represents the unit price of the individual item. The quantity field shows the…
9 properties
3 required
Discount
object
Discount applied to an order
2 properties
RecurringPaymentRequestMerchant
object
1 property
RecurringPaymentRequestEnrichmentsInitiationActor
string
The actor initiating the transaction. Use MERCHANT when the customer is not present.
RecurringPaymentRequestEnrichmentsInitiation
object
Describes who initiated the transaction
1 property
RecurringPaymentRequestEnrichments
object
1 property
RecurringPaymentRequest
object
17 properties
3 required
PaymentStatus
string
represents the status of the order
PaymentPaymentState
string
is the current state for capturing payments
Refund
object
To guarantee safe retries, the merchant should offer their refund ID or reference, aligning with their internal records Unique values for the requestID and mer…
6 properties
Order-Details
object
This comprehensive schema is designed to store an entire transaction's detail, covering crucial aspects like consumer information, billing and shipping details…
7 properties
Payment-Event
object
Each payment event has a unique ID, creation timestamp, and type (e.g., "AUTHAPPROVED", "AUTHDECLINED"). For "AUTHAPPROVED" events, an expiration timestamp is…
6 properties
Payment
object
Describes the schema for a (read-only) payment object
11 properties
PaymentAuthStatus
string
represents the status of the order
PaymentAuthPaymentState
string
is the current state for capturing payments
PaymentAuth
object
Describes the schema for a (read-only) payment object
11 properties
WebhooksAgreementStatusUpdatedPayloadContentApplicationJsonSchemaStatus
string
Current status of the agreement
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Cash App publishes across the network.
