Docs

API reference · Organizations

org management offers preview

POST/v1/management/offers/preview
Permission
authenticated: any signed-in caller or API token
Operation
org.management.offers.preview

Request body

FieldTypeRequiredNotes
secretstringyes1 to 200 characters

Response 200

FieldTypeRequiredNotes
offerobjectyes
offer.idstringyesfor example "moffer_01h455vb4pex5vsknk084sn02q"
offer.customerOrgIdstringyesfor example "org_01h455vb4pex5vsknk084sn02q"
offer.providerOrgIdstringyesfor example "org_01h455vb4pex5vsknk084sn02q"
offer.permissionsarray of stringyes1 to 100 items
offer.createdBystringyesfor example "user_01h455vb4pex5vsknk084sn02q"
offer.createdAtstring (date-time)yesUTC, ISO 8601.
offer.expiresAtstring (date-time)yesUTC, ISO 8601.
offer.revokedAtstring (date-time) or nullyes
offer.expiredbooleanyes
offer.consumedbooleanyes
customerobjectyes
customer.idstringyesfor example "org_01h455vb4pex5vsknk084sn02q"
customer.namestringyes
providerobjectyes
provider.idstringyesfor example "org_01h455vb4pex5vsknk084sn02q"
provider.namestringyes