atlas

Get Package by specified ID

Get Package by specified ID

get/atlas/v1/packages/{packageId}

Request

  • Base URL: https://api.beamcheckout.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.beamcheckout.com/atlas/v1/packages/{packageId}
  • Auth: OAuth 2 (implicit, authorization URL "")

Path parameters

packageIdstring required

packageId

Response

PackageWithFees

approvedAtstring
approvedBystring
createdAtstring
createdBystring
descriptionstring
disabledAtstring
disabledBystring
feeDescriptionstring

FeeDescription is not allowed to be created or updated yet, but will be migrated from fee modules' fee descriptions

idstring
isTargetedboolean
namestring
partnerIdstring

PartnerID is the ID of the partner that owns this package, empty if the package is not owned by any partner

partnerNamestring
rejectReasonstring
rejectedAtstring
rejectedBystring
status'SUBMITTED' | 'REJECTED' | 'APPROVED' | 'DISABLED'
updatedAtstring
updatedBystring

Changes

No recorded changes to this operation across all 1 revision of this API.