Skip to main content
GET
Error

Authorizations

Authorization
string
header
required

API key or access token

Response

Get Partner Program access

featureKey
enum<string>
required
Available options:
partner-program-participation
entitlementFeatureKey
enum<string>
required
Available options:
operate-agents-for-clients
protectedOAuthRenewalActionAvailable
boolean
required
state
enum<string>
required
Available options:
GRANTED,
PENDING,
DENIED,
ERROR
allowed
boolean
required
purchased
boolean
required
billingCustomerId
integer
required
Required range: 0 < x <= 9007199254740991
standing
object
required
ownership
object
required
registration
object
required
readiness
object
required
denialReasons
string[]
required
nextAction
enum<string>
required
Available options:
OPEN_PARENT_ORGANIZATION,
ACCEPT_OFFER,
SET_UP_PAYMENT,
FUND_PREPAY,
RESOLVE_BILLING_HOLD,
CLAIM_PROVIDER,
COMPLETE_CERTIFICATION,
CONTACT_SALES,
WAIT_FOR_START,
NONE
paymentSetupUrl
string
required
entitlementExpiresAt
string<date-time> | null
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$