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.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||