How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Cash App Billing Agreements API

The Billing Agreements API from Cash App — 8 operation(s) for billing agreements.

Cash App Billing Agreements API is one of 25 APIs that Cash App publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Billing Agreements. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 9 operations across 8 paths, and defines 29 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 2 base URLs: https://global-api-sandbox.afterpay.com, https://global-api.afterpay.com.

9 operations 8 paths 29 schemas 1 DELETE1 GET6 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.cash.app/network/v1
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

Cash App Billing Agreements API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (sec0).

Paths & Operations 9

Across 8 paths, the API surfaces 9 operations — 1 DELETE, 1 GET, 6 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Billing Agreements 9
POST
/v2/billing-agreements/approvals
Start Billing Agreement Approval Process
start-billing-agreement-approval 3 params body → 200401403415422
POST
/v2/billing-agreements
Create Billing Agreement
create-billing-agreement 3 params body → 200403412415
POST
/v2/billing-agreements/alias
Create Billing Agreement Alias
alias-billing-agreement 3 params body → 200403415
PUT
/v2/billing-agreements/cancel
Cancel Billing Agreement (Alternative)
cancel-billing-agreement-alt 3 params body → 200403404
POST
/v2/billing-agreements/offers
Retrieve Billing Agreement Offers
retrieve-billing-agreement-offers 3 params body → 200401403422
POST
/v2/billing-agreements/retrieve
Retrieve Billing Agreement
retrieve-billing-agreement 2 params body → 200403404
POST
/v2/billing-agreements/start
Start Billing Agreement Link Flow
start-billing-agreement-link 3 params body → 201404412429
GET
/v2/billing-agreements/{token}
Get Billing Agreement Details
get-billing-agreement 3 params → 200403404
DELETE
/v2/billing-agreements/{token}
Cancel Billing Agreement
cancel-billing-agreement 3 params → 200403404

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are BillingAgreementResponse (11 properties), Offer (8 properties), AgreementEventResponse (6 properties), BillingAgreementApprovalRequestMerchant (4 properties). Each schema is shown below with its type and property counts.

OfferType
string
Type of the offer
LinkStartResponse
object
Response containing the billing agreement link details
4 properties 4 required
ConsumerOffersNoPaymentUpfront
object
Information about the no payment upfront feature eligibility
2 properties 2 required
AgreementEventResponse
object
Response type for agreement events
6 properties
BillingAgreementResponse
object
Response type for billing agreements
11 properties 4 required
LinkStartRequest
object
Request to start a billing agreement link flow
2 properties 2 required
AgreementEventResponseType
string
Type of event
ConsumerOffers
object
Consumer offers
1 property
CancelBillingAgreementRequest
object
Request to cancel a billing agreement
1 property 1 required
BillingAgreementAliasRequest
object
Request to create an alias for a billing agreement
2 properties 1 required
AgreementApproval
object
Details about the agreement to be created.
2 properties 1 required
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
BillingAgreementApprovalResponse
object
Response from initiating a billing agreement approval process
3 properties 3 required
AgreementApprovalType
string
Agreement Type for approval.
BillingAgreementResponseType
string
Type of agreement
CreateAgreementRequest
object
3 properties 1 required
Money
object
Object containing amount and currency
2 properties 2 required
MoneyCurrency
string
BillingAgreementApprovalRequestMerchant
object
4 properties 2 required
BillingAgreementApprovalRequest
object
Request body for initiating a billing agreement approval process
4 properties 1 required
BillingAgreementResponseStatus
string
Current status of the agreement
BillingAgreementAliasResponse
object
Response containing the payment schedule token and its expiry
2 properties 2 required
Offer
object
Represents an offer with payment details
8 properties
OffersRequest
object
Request to retrieve available billing agreement offers
3 properties 3 required
AgreementEventResponseStatus
string
Status of the agreement at the time of the event
LinkStartResponseDeliveryType
string
How the verification code was delivered to the consumer
OffersResponse
object
Response containing available offers for the consumer
3 properties
PaymentSchedule
object
Represents a scheduled payment installment
2 properties 2 required
GetBillingAgreementRequest
object
Request to retrieve a billing agreement by token
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cash-app-billing-agreements-api-openapi.yml Raw ↑

Other APIs Cash App publishes across the network.

Cash App Add Cash App Pay To Your Site API
Cash App Balances API
Cash App Billing Agreements (Deprecated) API
Cash App Brands API
Cash App Customer Request API
Cash App Customers API
Cash App Disputes API
Cash App Grants Afterpay API
Cash App Merchants API
Cash App Network API
Cash App Payments API
Cash App Payouts API
Where this information came from

This is an independent, third-party profile of Cash App Billing Agreements API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.