Share a parent's entitlement with a child Account

Shares one entitlement that this Account's parent holds in Active state. The path Account must be a direct child of a parent Account. Select the child with X-Wingspan-Account, or call as a Person with Write access to it. The caller also needs Write access to the parent Account; a ServiceAccount's authority on the parent must extend to its descendants. Only subscription entitlements can be shared: ContractorPayments, ArInvoicing, EmployeePayroll, SCorpPayroll, Onboarding, TaxDocumentFiling, Organizations and PremiumSupport.

A shared entitlement follows the parent's state. While the parent's own entitlement is not Active, the child's entitlement reads whichever ends access sooner: the parent's state and notAfter, or the child's own wind-down. A removed share stays Removed. Once the parent's entitlement is Active again, so is the child's, unless the share itself is winding down or removed.

Sharing ContractorPayments copies the parent's payout terms to the child only when no earlier share has ever set the child's ContractorPayments payout terms. Once they are set, later shares never change them, including a share that makes the entitlement Active again. A share also takes over a ContractorPayments the child holds only from the entitlement backfill, so the child's entitlement then follows the parent. Sharing again an entitlement the child holds in Active state changes nothing; sharing one that is winding down makes it Active again.

Refusals carry a detailCode: users.ParentEntitlementNotActive (409) when the parent does not hold the entitlement in Active state, users.NotChildOfParent (409) when the Account has no parent, users.EntitlementNotShareable (422) for an entitlement that is not a subscription, users.ExclusiveEntitlementHeld (409) when the Account holds an entitlement that excludes this one (SCorpPayroll and EmployeePayroll exclude each other), and users.ProductUnavailable (409) when the product is not offered.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
^(?:[A-Za-z0-9_.]{22}|[a-f0-9]{24})$

Account identifier. Newly created V3 Accounts use a 22-character Wingspan ID; migrated Accounts may retain a 24-character lowercase hexadecimal ID.

Body Params
string
enum
required

The product an entitlement grants. ContractorPayments is Payments (AP) Full, ArInvoicing is Collections (AR) Full, PaymentsBasic is Payments (AP) Basic, CollectionsBasic is Collections (AR) Basic and EmployeePayroll is Payroll.

Headers
string
^(?:[A-Za-z0-9_.]{22}|[a-f0-9]{24})$

Select the Account for an Account-scoped operation. A direct ServiceAccount API key MUST supply this header, and the target must be within the ServiceAccount owner's or Authorization grant's Account boundary. A Person bearer may select an Account on which it has an active Stakeholder, and an Account session may select its bound Account (or a descendant only when the session explicitly includes descendants).

string
length between 1 and 255
^[\x21-\x7e]{1,255}$

Optional idempotency token for authenticated POST and PATCH requests. Reusing the same key and body returns the cached response for 24 hours, except credential operations that explicitly document a 409 because one-time secret material is never cached; reusing it with a different body returns 409 IdempotencyKeyConflict. Use 1-255 printable ASCII characters.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json