Get complimentary access
get_complimentary_accessRetrieve details of a specific complimentary access for a publication, optionally expanding tier information. Requires publication and complimentary access IDs.
Instructions
Get complimentary access. Reads account data. OAuth integrations require complimentary_access:read.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| expand | No | Optional list of expandable objects. `tier` - Returns the full tier object associated with this complimentary access. | |
| account | No | Named private account from BEEHIIV_ACCOUNTS. Defaults to BEEHIIV_DEFAULT_ACCOUNT or the first configured account. | |
| publication_id | Yes | The prefixed ID of the publication object | |
| complimentary_access_id | Yes | The prefixed ID of the complimentary access object |