Relationship Resource

The Relationship resource represents a direct, one-directional parent-child link between two accounts. It identifies which account is the parent and which is the child, and includes basic details of both linked accounts. To learn how relationships are established, check the Linked Accounts guide.

Relationship Resource

{
  "data": {
    "id": "mr_1a2b3c4d5e6f7a8b9c0d1e2f",
    "parent_account_id": "org_1a2b3c4d5e6f7a8b9c0d1e2f",
    "child_account_id": "org_2b3c4d5e6f7a8b9c0d1e2f3a",
    "enabled": true,
    "linking_request_id": "lr_3c4d5e6f7a8b9c0d1e2f3a4b",
    "parent_account": {
      "id": "org_1a2b3c4d5e6f7a8b9c0d1e2f",
      "account_type": "merchant",
      "activation_status": "activated",
      "enabled": true,
      "trade_name": "Acme Platform",
      "legal_name": "Acme Platform Corporation",
      "business_type": "corporation"
    },
    "child_account": {
      "id": "org_2b3c4d5e6f7a8b9c0d1e2f3a",
      "account_type": "merchant",
      "activation_status": "activated",
      "enabled": true,
      "trade_name": "Juan's Coffee",
      "legal_name": "Juan Dela Cruz Coffee Trading",
      "business_type": "sole_proprietor"
    },
    "created_at": 1719849600,
    "updated_at": 1720022400
  }
}

id string
A system-generated unique identifier for the relationship. Prefixed with mr_.

parent_account_id string
The ID of the parent account in the relationship. Prefixed with org_.

child_account_id string
The ID of the child account in the relationship. Prefixed with org_.

enabled boolean
Whether the relationship is enabled. This is the relationship's own flag; each linked account also carries its own enabled flag on its account summary.

linking_request_id string | null
The ID of the linking request that established the relationship. Prefixed with lr_. null for relationships without an originating linking request.

parent_account object
Basic details of the parent account.

parent_account.id string
A system-generated unique identifier for the account. Prefixed with org_.

parent_account.account_type string
The type of account. Either merchant or consumer.

parent_account.activation_status string
The current activation status of the account. Can be pending, under_review, activated, or declined.

parent_account.enabled boolean
Whether the account itself is enabled. Distinct from the relationship's enabled flag.

parent_account.trade_name string
The account's trade name.

parent_account.legal_name string
The account's legal name.

parent_account.business_type string
The business entity type (e.g., individual, sole_proprietor, corporation). Consumer accounts carry individual.

child_account object
Basic details of the child account. Same structure as parent_account.

created_at integer
Unix timestamp indicating when the relationship was created.

updated_at integer
Unix timestamp indicating when the relationship was last updated.