Bill agreement balance

Bills the balance for an agreement, by ID. In the JSON request body, include an optional note that describes the reason for the billing action and the agreement amount and currency.

Authorization

AuthorizationBearer <token>

Oauth 2.0 authentication

FlowClient CredentialsToken URLhttps://api-m.paypal.com/v1/oauth2/tokenInheader

Scopes

Create and Manage a billing-agreementhttps://uri.paypal.com/services/subscriptions

Path Parameters

agreement_id*string

The ID of the agreement for which to bill the balance.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X POST "https://api-m.paypal.com/v1/payments/billing-agreements/string/bill-balance" \  -H "Content-Type: application/json" \  -d '{    "note": "Billing balance amount."  }'

Empty

{
  "name": "string",
  "debug_id": "string",
  "message": "string",
  "information_link": "string",
  "details": [
    {
      "field": "string",
      "issue": "string"
    }
  ]
}

Bills the balance for an agreement, by ID. In the JSON request body, include an optional note that describes the reason for the billing action and the agreement amount and currency.

Authorization

AuthorizationBearer <token>

Oauth 2.0 authentication

FlowClient CredentialsToken URLhttps://api-m.paypal.com/v1/oauth2/tokenInheader

Scopes

Create and Manage a billing-agreementhttps://uri.paypal.com/services/subscriptions

Path Parameters

agreement_id*string

The ID of the agreement for which to bill the balance.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

note?string

The reason for the agreement state change.

Lengthlength <= 128

Response Body

`application/json`

curl -X POST "https://api-m.paypal.com/v1/payments/billing-agreements/string/bill-balance" \  -H "Content-Type: application/json" \  -d '{    "note": "Billing balance amount."  }'

Empty

{
  "name": "string",
  "debug_id": "string",
  "message": "string",
  "information_link": "string",
  "details": [
    {
      "field": "string",
      "issue": "string"
    }
  ]
}

Bill agreement balance

204

defaultapplication/json

On this page

If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more

Bill agreement balance

204

defaultapplication/json

`application/json`

`application/json`