Draft Cancel Billing Agreement

DELETE https://api-sandbox.afterpay.com/v2/billing-agreements/{token} HTTP/1.1
Host: api-sandbox.afterpay.com
Accept: application/json

Name	In	Type	Required	Description
token	path	string	yes	The token of the agreement to be cancelled.

Name

Type

Required

Description

token

path

string

yes

The token of the agreement to be cancelled.

Status	Meaning	Description	Schema
200	OK	Successful. Returns the billing agreement object with a status of cancelled.	Agreement
401	Unauthorised	Invalid Merchant API credentials were passed in the Authorisation header.	Error
404	Not Found	The agreement with the given ID could not be found.	Error
405	Method Not Allowed	The request used an unacceptable HTTP method. Depending on the endpoint, only PUT or POST requests are allowed. Use the OPTIONS HTTP method to decide which methods are allowed for each endpoint.	Error
406	Not Acceptable	The request included an Accept header for something other than application/json or ”/“	Error
412	Precondition Failed	The agreement has already been cancelled.	Error
500	Internal Server Error	A common cause of this response from PUT/POST endpoints is that the request body is missing or empty.	Error

Status

Meaning

Description

Schema

200

Successful. Returns the billing agreement object with a status of cancelled.

Agreement

401

Unauthorised

Invalid Merchant API credentials were passed in the Authorisation header.

Error

404

Not Found

The agreement with the given ID could not be found.

Error

405

Method Not Allowed

The request used an unacceptable HTTP method. Depending on the endpoint, only PUT or POST requests are allowed. Use the OPTIONS HTTP method to decide which methods are allowed for each endpoint.

Error

406

Not Acceptable

The request included an Accept header for something other than application/json or ”/“

Error

412

Precondition Failed

The agreement has already been cancelled.

Error

500

Internal Server Error

A common cause of this response from PUT/POST endpoints is that the request body is missing or empty.

Error

{
  "id": "_7IgXzApNiRoxpEb04LbAFQShsvdE_H3",
  "merchantReference": "merchant-billing-agreement-1234",
  "pageUrl": "https://merchant.com/billing-agreement",
  "consumer": {
    "phoneNumber": "0400 000 000",
    "givenNames": "Joe",
    "surname": "Customer",
    "email": "test@example.com"
  },
  "createdAt": "2021-04-16T02:49:04.740Z",
  "status": "CANCELLED",
  "cancelledAt": "2021-07-05T11:23:07.740Z"
}

{
  "errorCode": "unauthorized",
  "errorId": "16628d4fb02900d4",
  "message": "Credentials are required to access this resource.",
  "httpStatusCode": 401
}

{
  "errorCode": "not_found",
  "errorId": "16628d4fb02900d4",
  "message": "Not found",
  "httpStatusCode": 404
}

{
  "errorCode": "method_not_allowed",
  "errorId": "16628d4fb02900d4",
  "message": "Method not allowed",
  "httpStatusCode": 405
}

{
  "errorCode": "invalid_billing_agreement_status",
  "errorId": "16628d4fb02900d4",
  "message": "The billing agreement has already been cancelled.",
  "httpStatusCode": 412
}

{
  "errorCode": "error",
  "errorId": "16628d4fb02900d4",
  "message": "Internal server error",
  "httpStatusCode": 500
}

DELETE https://api-sandbox.afterpay.com/v2/billing-agreements/{token} HTTP/1.1
Host: api-sandbox.afterpay.com
Accept: application/json

Name	In	Type	Required	Description
token	path	string	yes	The token of the agreement to be cancelled.

Name

Type

Required

Description

token

path

string

yes

The token of the agreement to be cancelled.

Status	Meaning	Description	Schema
200	OK	Successful. Returns the billing agreement object with a status of cancelled.	Agreement
401	Unauthorised	Invalid Merchant API credentials were passed in the Authorisation header.	Error
404	Not Found	The agreement with the given ID could not be found.	Error
405	Method Not Allowed	The request used an unacceptable HTTP method. Depending on the endpoint, only PUT or POST requests are allowed. Use the OPTIONS HTTP method to decide which methods are allowed for each endpoint.	Error
406	Not Acceptable	The request included an Accept header for something other than application/json or ”/“	Error
412	Precondition Failed	The agreement has already been cancelled.	Error
500	Internal Server Error	A common cause of this response from PUT/POST endpoints is that the request body is missing or empty.	Error

Status

Meaning

Description

Schema

200

Successful. Returns the billing agreement object with a status of cancelled.

Agreement

401

Unauthorised

Invalid Merchant API credentials were passed in the Authorisation header.

Error

404

Not Found

The agreement with the given ID could not be found.

Error

405

Method Not Allowed

The request used an unacceptable HTTP method. Depending on the endpoint, only PUT or POST requests are allowed. Use the OPTIONS HTTP method to decide which methods are allowed for each endpoint.

Error

406

Not Acceptable

The request included an Accept header for something other than application/json or ”/“

Error

412

Precondition Failed

The agreement has already been cancelled.

Error

500

Internal Server Error

A common cause of this response from PUT/POST endpoints is that the request body is missing or empty.

Error

{
  "id": "_7IgXzApNiRoxpEb04LbAFQShsvdE_H3",
  "merchantReference": "merchant-billing-agreement-1234",
  "pageUrl": "https://merchant.com/billing-agreement",
  "consumer": {
    "phoneNumber": "0400 000 000",
    "givenNames": "Joe",
    "surname": "Customer",
    "email": "test@example.com"
  },
  "createdAt": "2021-04-16T02:49:04.740Z",
  "status": "CANCELLED",
  "cancelledAt": "2021-07-05T11:23:07.740Z"
}

{
  "errorCode": "unauthorized",
  "errorId": "16628d4fb02900d4",
  "message": "Credentials are required to access this resource.",
  "httpStatusCode": 401
}

{
  "errorCode": "not_found",
  "errorId": "16628d4fb02900d4",
  "message": "Not found",
  "httpStatusCode": 404
}

{
  "errorCode": "method_not_allowed",
  "errorId": "16628d4fb02900d4",
  "message": "Method not allowed",
  "httpStatusCode": 405
}

{
  "errorCode": "invalid_billing_agreement_status",
  "errorId": "16628d4fb02900d4",
  "message": "The billing agreement has already been cancelled.",
  "httpStatusCode": 412
}

{
  "errorCode": "error",
  "errorId": "16628d4fb02900d4",
  "message": "Internal server error",
  "httpStatusCode": 500
}

Draft Cancel Billing Agreement

Draft Cancel Billing Agreement

Note

Recurring Payments - More Information

Note

Recurring Payments - More Information

1	DELETE https://api-sandbox.afterpay.com/v2/billing-agreements/{token} HTTP/1.1
2	Host: api-sandbox.afterpay.com
3	Accept: application/json

1	{
2	"id": "_7IgXzApNiRoxpEb04LbAFQShsvdE_H3",
3	"merchantReference": "merchant-billing-agreement-1234",
4	"pageUrl": "https://merchant.com/billing-agreement",
5	"consumer": {
6	"phoneNumber": "0400 000 000",
7	"givenNames": "Joe",
8	"surname": "Customer",
9	"email": "test@example.com"
10	},
11	"createdAt": "2021-04-16T02:49:04.740Z",
12	"status": "CANCELLED",
13	"cancelledAt": "2021-07-05T11:23:07.740Z"
14	}

1	{
2	"errorCode": "unauthorized",
3	"errorId": "16628d4fb02900d4",
4	"message": "Credentials are required to access this resource.",
5	"httpStatusCode": 401
6	}

1	{
2	"errorCode": "not_found",
3	"errorId": "16628d4fb02900d4",
4	"message": "Not found",
5	"httpStatusCode": 404
6	}

1	{
2	"errorCode": "method_not_allowed",
3	"errorId": "16628d4fb02900d4",
4	"message": "Method not allowed",
5	"httpStatusCode": 405
6	}

1	{
2	"errorCode": "invalid_billing_agreement_status",
3	"errorId": "16628d4fb02900d4",
4	"message": "The billing agreement has already been cancelled.",
5	"httpStatusCode": 412
6	}

1	{
2	"errorCode": "error",
3	"errorId": "16628d4fb02900d4",
4	"message": "Internal server error",
5	"httpStatusCode": 500
6	}