Delete an Apple Pay domain | Sample

1 parameter

domainstringrequired

The unique identifier of the Apple Pay domain to delete. Maximum 5,000 characters.

2 status codes

200Returns a deleted Apple Pay domain object with `deleted` set to true, the deleted domain identifier, and object type `apple_pay_domain`.

deletedbooleanrequired

Always true for a deleted object

Allowed:true

idstringrequired

Unique identifier for the object.

objectstringrequired

String representing the object's type. Objects of the same type share the same value.

Allowed:apple_pay_domain

defaultError response.

errorobjectrequired

Error handling

domain must be no longer than 5,000 characters and must identify an existing Apple Pay domain registration. The identifier must refer to the domain object you intend to delete.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.domains.delete({ domain: "example" });

{
  "deleted": "true",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "object": "apple_pay_domain"
}

Request

Response

Errors