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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Braintree

braintree Subscriptions API

Operations for creating, retrieving, updating, canceling, and retrying customer subscriptions to recurring billing plans.

Documentation Provider Profile APIs.io OpenAPI GitHub

braintree Subscriptions API is one of 14 APIs that Braintree publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Subscription. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 4 paths, and defines 9 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://api.braintreegateway.com/merchants/{merchantId}, https://api.sandbox.braintreegateway.com/merchants/{merchantId}.

5 operations 4 paths 9 schemas 1 GET2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.braintreegateway.com
Authentication
HTTP Basic
Contact
Braintree Developer Support
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

braintree Subscriptions API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • basicAuth — HTTP Basic Authentication using the merchant's public API key as the username and private API key as the password, Base64-encoded per RFC 7617.

Paths & Operations 5

Across 4 paths, the API surfaces 5 operations — 1 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Subscriptions 5

Operations for creating, retrieving, updating, canceling, and retrying customer subscriptions to recurring billing plans.

POST
/subscriptions
Create a subscription
createSubscription body → 201400401422
GET
/subscriptions/{subscriptionId}
Get a subscription
getSubscription 1 param → 200401404
PUT
/subscriptions/{subscriptionId}
Update a subscription
updateSubscription 1 param body → 200400401404
PUT
/subscriptions/{subscriptionId}/cancel
Cancel a subscription
cancelSubscription 1 param → 200401404
POST
/subscriptions/{subscriptionId}/retry_charge
Retry a subscription charge
retrySubscriptionCharge 1 param body → 201400401404

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are Subscription (24 properties), SubscriptionRequest (17 properties), SubscriptionUpdateRequest (10 properties), AppliedModification (7 properties). Each schema is shown below with its type and property counts.

AppliedModification
object
An add-on or discount currently applied to a subscription, including the inherited or overridden values.
7 properties
SubscriptionUpdateRequest
object
Request body for updating an existing subscription.
10 properties
Descriptor
object
Dynamic descriptor fields that appear on the customer's bank statement to identify the merchant and charge.
3 properties
ModificationAdd
object
An add-on or discount to add to a subscription.
5 properties 1 required
ModificationCollection
object
A collection of add-on or discount operations to apply when creating or updating a subscription.
3 properties
SubscriptionRequest
object
Request body for creating a new subscription. A paymentmethodtoken or paymentmethodnonce is required along with the planid.
17 properties 1 required
Subscription
object
Represents a recurring billing subscription that charges a customer's vaulted payment method on a defined schedule according to a billing plan.
24 properties
ModificationUpdate
object
An existing add-on or discount on a subscription to update.
5 properties 1 required
Error
object
Standard error response returned by the Braintree API.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

braintree-subscriptions-api-openapi.yml Raw ↑

Other APIs Braintree publishes across the network.

Braintree GraphQL API
AE Profile APIs.io
Braintree JavaScript Client SDK
AE Profile APIs.io
Braintree iOS SDK
AE Profile APIs.io
Braintree Android SDK
AE Profile APIs.io
Braintree Webhooks
AE Profile APIs.io
braintree Add-Ons API
AE Profile APIs.io
braintree Client Tokens API
AE Profile APIs.io
braintree Customers API
AE Profile APIs.io
braintree Discounts API
AE Profile APIs.io
braintree Disputes API
AE Profile APIs.io
braintree Payment Methods API
AE Profile APIs.io
braintree Plans API
AE Profile APIs.io
#Subscription
← Back to B APIs
API Details
ID
braintree:braintree-subscriptions-api
Base URL
https://api.braintreegateway.com
Docs
https://developer.paypal.com/braintree/docs/
Provider
Braintree
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=braintree-subscriptions-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/braintree-subscriptions-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of braintree Subscriptions 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.