> For the complete documentation index, see [llms.txt](https://docs.archera.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.archera.ai/api-reference/partner-api/models.md). # Models ## The Error object ```json {"openapi":"3.1.0","info":{"title":"Archera.ai Channel Partner API","version":"v1.0.0"},"components":{"schemas":{"Error":{"type":"object","properties":{"code":{"type":"integer","description":"Error code"},"status":{"type":"string","description":"Error name"},"message":{"type":"string","description":"Error message"},"errors":{"type":"object","description":"Errors","additionalProperties":{}}},"additionalProperties":false}}}} ``` ## The PaginationMetadata object ```json {"openapi":"3.1.0","info":{"title":"Archera.ai Channel Partner API","version":"v1.0.0"},"components":{"schemas":{"PaginationMetadata":{"type":"object","properties":{"total":{"type":"integer","description":"Total number of items."},"total_pages":{"type":"integer","description":"Total number of pages."},"first_page":{"type":"integer","description":"First available page number."},"last_page":{"type":"integer","description":"Last available page number."},"page":{"type":"integer","description":"Current page number."},"previous_page":{"type":"integer","description":"Previous page number."},"next_page":{"type":"integer","description":"Next page number."}},"additionalProperties":false}}}} ``` ## The ApiErrorResponse object ```json {"openapi":"3.1.0","info":{"title":"Archera.ai Channel Partner API","version":"v1.0.0"},"components":{"schemas":{"ApiErrorResponse":{"type":"object","properties":{"message":{"type":"string"},"detail":{},"code":{"type":["string","null"]},"url":{"type":["string","null"]},"timestamp":{"type":"string"},"type":{"type":"string"}},"required":["message","timestamp","type"]}}}} ``` ## The UserInvite object ```json {"openapi":"3.1.0","info":{"title":"Archera.ai Channel Partner API","version":"v1.0.0"},"components":{"schemas":{"UserInvite":{"type":"object","properties":{"email":{"type":"string","format":"email","maxLength":255},"role":{"type":"string","enum":["user","admin","support","cloud_rep","restricted_user"]}},"required":["email"],"additionalProperties":false}}}} ``` ## The MutateAddress object ```json {"openapi":"3.1.0","info":{"title":"Archera.ai Channel Partner API","version":"v1.0.0"},"components":{"schemas":{"MutateAddress":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":["string","null"],"default":null},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"country":{"type":"string"}},"required":["city","country","line1","state","zip"],"additionalProperties":false}}}} ``` ## The RegisterOrg object ```json {"openapi":"3.1.0","info":{"title":"Archera.ai Channel Partner API","version":"v1.0.0"},"components":{"schemas":{"RegisterOrg":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"Name of the child organization. At most 255 characters, and unique across all Archera organizations; a name already in use returns 409. The stored name gains a ' c/o ' suffix, which also counts towards the 255-character limit."},"labra_subscription_id":{"type":"string"},"users":{"type":"array","items":{"$ref":"#/components/schemas/UserInvite"}},"domain":{"type":["string","null"]},"primary_address":{"anyOf":[{"$ref":"#/components/schemas/MutateAddress"},{"type":"null"}]},"aws_marketplace_offer_link":{"type":["string","null"],"format":"url"},"azure_marketplace_offer_link":{"type":["string","null"],"format":"url"},"gcp_marketplace_offer_link":{"type":["string","null"],"format":"url"}},"required":["name"],"additionalProperties":false},"UserInvite":{"type":"object","properties":{"email":{"type":"string","format":"email","maxLength":255},"role":{"type":"string","enum":["user","admin","support","cloud_rep","restricted_user"]}},"required":["email"],"additionalProperties":false},"MutateAddress":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":["string","null"],"default":null},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"country":{"type":"string"}},"required":["city","country","line1","state","zip"],"additionalProperties":false}}}} ``` ## The OrgMembershipResponse object ```json {"openapi":"3.1.0","info":{"title":"Archera.ai Channel Partner API","version":"v1.0.0"},"components":{"schemas":{"OrgMembershipResponse":{"type":"object","properties":{"role":{"type":"string","enum":["user","admin","support","cloud_rep","restricted_user"],"readOnly":true},"username":{"type":"string","format":"email","readOnly":true,"maxLength":255}},"additionalProperties":false}}}} ``` ## The RegisterOrgResponse object ```json {"openapi":"3.1.0","info":{"title":"Archera.ai Channel Partner API","version":"v1.0.0"},"components":{"schemas":{"RegisterOrgResponse":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true},"memberships":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/OrgMembershipResponse"}},"domain":{"type":["string","null"],"readOnly":true},"primary_address":{"readOnly":true,"anyOf":[{"$ref":"#/components/schemas/MutateAddress"},{"type":"null"}]},"aws_marketplace_offer_link":{"type":["string","null"],"format":"url","readOnly":true},"azure_marketplace_offer_link":{"type":["string","null"],"format":"url","readOnly":true},"gcp_marketplace_offer_link":{"type":["string","null"],"format":"url","readOnly":true}},"required":["id","name"],"additionalProperties":false},"OrgMembershipResponse":{"type":"object","properties":{"role":{"type":"string","enum":["user","admin","support","cloud_rep","restricted_user"],"readOnly":true},"username":{"type":"string","format":"email","readOnly":true,"maxLength":255}},"additionalProperties":false},"MutateAddress":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":["string","null"],"default":null},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"country":{"type":"string"}},"required":["city","country","line1","state","zip"],"additionalProperties":false}}}} ``` ## The InviteUsers object ```json {"openapi":"3.1.0","info":{"title":"Archera.ai Channel Partner API","version":"v1.0.0"},"components":{"schemas":{"InviteUsers":{"type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/components/schemas/UserInvite"}}},"required":["users"],"additionalProperties":false},"UserInvite":{"type":"object","properties":{"email":{"type":"string","format":"email","maxLength":255},"role":{"type":"string","enum":["user","admin","support","cloud_rep","restricted_user"]}},"required":["email"],"additionalProperties":false}}}} ``` ## The UserInfo object ```json {"openapi":"3.1.0","info":{"title":"Archera.ai Channel Partner API","version":"v1.0.0"},"components":{"schemas":{"UserInfo":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"maxLength":50},"username":{"type":"string","maxLength":255},"full_name":{"type":["string","null"],"maxLength":255}},"required":["username"],"additionalProperties":false}}}} ``` ## The Credential object ```json {"openapi":"3.1.0","info":{"title":"Archera.ai Channel Partner API","version":"v1.0.0"},"components":{"schemas":{"Credential":{"type":"object","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"org_id":{"type":"string","readOnly":true,"maxLength":50},"name":{"type":"string","readOnly":true},"client_id":{"type":["string","null"],"readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"user_id":{"type":["string","null"],"readOnly":true,"maxLength":50},"last_used_at":{"type":["string","null"],"format":"date-time","readOnly":true},"expires_at":{"type":["string","null"],"format":"date-time","readOnly":true},"revoked":{"type":"boolean","readOnly":true},"azure_tenant_id":{"type":["string","null"],"readOnly":true,"maxLength":50},"azure_csp_plan_subscription_id":{"type":["string","null"],"readOnly":true,"maxLength":50},"type":{"readOnly":true,"type":"string","enum":["tds_api_key"]},"user":{"readOnly":true,"$ref":"#/components/schemas/UserInfo"}},"required":["azure_csp_plan_subscription_id","azure_tenant_id","client_id","created_at","expires_at","id","last_used_at","name","org_id","revoked","type","user","user_id"],"additionalProperties":false},"UserInfo":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"maxLength":50},"username":{"type":"string","maxLength":255},"full_name":{"type":["string","null"],"maxLength":255}},"required":["username"],"additionalProperties":false}}}} ``` ## The CreateCredential object ```json {"openapi":"3.1.0","info":{"title":"Archera.ai Channel Partner API","version":"v1.0.0"},"components":{"schemas":{"CreateCredential":{"type":"object","properties":{"value":{"type":"string"},"client_id":{"type":"string"},"name":{"type":"string","default":"PAC Proxy Credential"},"type":{"default":"tds_api_key","type":"string","enum":["tds_api_key"]},"expires_at":{"type":["string","null"],"format":"date-time","default":null},"azure_tenant_id":{"type":"string","pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\\Z"},"azure_csp_plan_subscription_id":{"type":"string","pattern":"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\\Z"}},"required":["azure_csp_plan_subscription_id","azure_tenant_id","client_id","value"]}}}} ``` ## The UpdateCredential object ```json {"openapi":"3.1.0","info":{"title":"Archera.ai Channel Partner API","version":"v1.0.0"},"components":{"schemas":{"UpdateCredential":{"type":"object","properties":{"name":{"type":"string"},"revoked":{"type":"boolean"}}}}}} ``` ## The CloudFormation object ```json {"openapi":"3.1.0","info":{"title":"Archera.ai Channel Partner API","version":"v1.0.0"},"components":{"schemas":{"CloudFormation":{"type":"object","properties":{"template":{"type":"object","additionalProperties":{}}},"additionalProperties":false}}}} ``` ## The LaunchStackUrls object ```json {"openapi":"3.1.0","info":{"title":"Archera.ai Channel Partner API","version":"v1.0.0"},"components":{"schemas":{"LaunchStackUrls":{"type":"object","properties":{"url":{"type":"string"}},"required":["url"],"additionalProperties":false}}}} ``` ## The ExistingCUR object ```json {"openapi":"3.1.0","info":{"title":"Archera.ai Channel Partner API","version":"v1.0.0"},"components":{"schemas":{"ExistingCUR":{"type":"object","properties":{"region":{"type":"string"},"bucket":{"type":"string"},"prefix":{"type":"string"},"report_name":{"type":"string"}},"required":["bucket","prefix","region","report_name"],"additionalProperties":false}}}} ``` ## The VerificationArgs object ```json {"openapi":"3.1.0","info":{"title":"Archera.ai Channel Partner API","version":"v1.0.0"},"components":{"schemas":{"VerificationArgs":{"type":"object","properties":{"onboarding_id":{"type":"string","pattern":"[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}\\Z"},"account_id":{"type":"string"},"read_only":{"type":"boolean","default":false},"existing_cur":{"$ref":"#/components/schemas/ExistingCUR"}},"additionalProperties":false},"ExistingCUR":{"type":"object","properties":{"region":{"type":"string"},"bucket":{"type":"string"},"prefix":{"type":"string"},"report_name":{"type":"string"}},"required":["bucket","prefix","region","report_name"],"additionalProperties":false}}}} ``` ## The Validation object ```json {"openapi":"3.1.0","info":{"title":"Archera.ai Channel Partner API","version":"v1.0.0"},"components":{"schemas":{"Validation":{"type":"object","properties":{"feature":{"type":"string"},"status":{"type":"string","enum":["available","warning","missing","unknown"]}},"additionalProperties":false}}}} ``` ## The AzureAuthUrlArgs object ```json {"openapi":"3.1.0","info":{"title":"Archera.ai Channel Partner API","version":"v1.0.0"},"components":{"schemas":{"AzureAuthUrlArgs":{"type":"object","properties":{"azure_tenant_id":{"type":"string"},"azure_subscription_id":{"type":"string"},"read_only":{"type":"boolean","default":false,"description":"Onboard without purchase permissions. The integration can read cost data and existing commitments, but cannot buy or exchange them."}},"required":["azure_subscription_id","azure_tenant_id"],"additionalProperties":false}}}} ``` ## The AzureAuthUrlResponse object ```json {"openapi":"3.1.0","info":{"title":"Archera.ai Channel Partner API","version":"v1.0.0"},"components":{"schemas":{"AzureAuthUrlResponse":{"type":"object","properties":{"url":{"type":"string"}},"required":["url"],"additionalProperties":false}}}} ``` ## The AzureCliScriptArgs object ```json {"openapi":"3.1.0","info":{"title":"Archera.ai Channel Partner API","version":"v1.0.0"},"components":{"schemas":{"AzureCliScriptArgs":{"type":"object","properties":{"azure_tenant_id":{"type":"string"},"azure_subscription_id":{"type":"string"},"read_only":{"type":"boolean","description":"Render the script without purchase permissions. The integration can read cost data and existing commitments, but cannot buy or exchange them."},"azure_resource_group":{"type":"string","pattern":"^[\\w().-]+(?' suffix, which also counts towards the 255-character limit."},"labra_subscription_id":{"type":"string"},"email":{"type":["string","null"],"format":"email","default":null,"maxLength":255}},"required":["company"],"additionalProperties":false}}}} ``` ## The PartnerRegisterOrgResponse object ```json {"openapi":"3.1.0","info":{"title":"Archera.ai Channel Partner API","version":"v1.0.0"},"components":{"schemas":{"PartnerRegisterOrgResponse":{"type":"object","properties":{"org_id":{"type":"string"}},"additionalProperties":false}}}} ``` ## The StartOnboarding object ```json {"openapi":"3.1.0","info":{"title":"Archera.ai Channel Partner API","version":"v1.0.0"},"components":{"schemas":{"StartOnboarding":{"type":"object","properties":{"onboarding_id":{"type":"string"}},"additionalProperties":false}}}} ``` ## The ListChildOrgsResponse object ```json {"openapi":"3.1.0","info":{"title":"Archera.ai Channel Partner API","version":"v1.0.0"},"components":{"schemas":{"ListChildOrgsResponse":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time"},"org_id":{"type":"string"},"org_name":{"type":"string"},"org_checklist":{"type":"array","items":{"$ref":"#/components/schemas/Validation"}},"integration_checklist":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/Validation"}}}},"required":["created_at","integration_checklist","org_checklist","org_id","org_name"],"additionalProperties":false},"Validation":{"type":"object","properties":{"feature":{"type":"string"},"status":{"type":"string","enum":["available","warning","missing","unknown"]}},"additionalProperties":false}}}} ``` ## The PurchasePlanContractSpec object ```json {"openapi":"3.1.0","info":{"title":"Archera.ai Channel Partner API","version":"v1.0.0"},"components":{"schemas":{"PurchasePlanContractSpec":{"type":"object","properties":{"commitment_type":{"type":"string"},"properties":{"type":"object","default":{},"additionalProperties":{}},"term":{"default":null,"type":["string","null"],"enum":["one_year_gris","thirty_day_gris","two_month_gris","three_month_gris","four_month_gris","five_month_gris","six_month_gris","seven_month_gris","eight_month_gris","nine_month_gris","ten_month_gris","eleven_month_gris","twelve_month_gris","thirteen_month_gris","fourteen_month_gris","fifteen_month_gris","sixteen_month_gris","seventeen_month_gris","eighteen_month_gris","nineteen_month_gris","twenty_month_gris","twenty_one_month_gris","twenty_two_month_gris","twenty_three_month_gris","twenty_four_month_gris","twenty_five_month_gris","twenty_six_month_gris","twenty_seven_month_gris","twenty_eight_month_gris","twenty_nine_month_gris","thirty_month_gris","thirty_one_month_gris","thirty_two_month_gris","thirty_three_month_gris","thirty_four_month_gris","thirty_five_month_gris","one_year","two_year","three_year","five_year","zero_day","thirty_day","two_month","three_month","four_month","five_month","six_month","seven_month","eight_month","nine_month","ten_month","eleven_month","thirteen_month","fourteen_month","fifteen_month","sixteen_month","seventeen_month","eighteen_month","nineteen_month","twenty_month","twenty_one_month","twenty_two_month","twenty_three_month","twenty_five_month","twenty_six_month","twenty_seven_month","twenty_eight_month","twenty_nine_month","thirty_month","thirty_one_month","thirty_two_month","thirty_three_month","thirty_four_month","thirty_five_month",null]},"payment_option":{"default":null,"type":["string","null"],"enum":["no_upfront","partial_upfront","all_upfront",null]}},"required":["commitment_type"],"additionalProperties":false}}}} ``` ## The CostEstimateSource object ```json {"openapi":"3.1.0","info":{"title":"Archera.ai Channel Partner API","version":"v1.0.0"},"components":{"schemas":{"CostEstimateSource":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"updated_at":{"type":"string","format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["deleted_at","id","name","updated_at"],"additionalProperties":false}}}} ``` ## The MetaPlanInfo object ```json {"openapi":"3.1.0","info":{"title":"Archera.ai Channel Partner API","version":"v1.0.0"},"components":{"schemas":{"MetaPlanInfo":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"is_default":{"type":"boolean","readOnly":true}},"required":["created_at","id","is_default","name"],"additionalProperties":false}}}} ``` ## The PlanInfo object ```json {"openapi":"3.1.0","info":{"title":"Archera.ai Channel Partner API","version":"v1.0.0"},"components":{"schemas":{"PlanInfo":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"executed_via":{"readOnly":true,"description":"How the plan was submitted. `automation` means a policy applied it rather than a person, which is what lets a client hide routine automated churn.","type":["string","null"],"enum":["user","agent_in_app","agent_slack","mcp","api","partner","automation",null]},"submitted_at":{"type":["string","null"],"format":"date-time","readOnly":true,"description":"When the plan was submitted for purchase. Null while it is a draft. Archera executes submitted plans within 5 business days, so this is the clock a 'where is my purchase' question is measured against."},"cancelled_at":{"type":["string","null"],"format":"date-time","readOnly":true,"description":"When the plan was cancelled; null while it is alive."},"cancellation_reason":{"readOnly":true,"description":"Why the plan was cancelled: checks_failed, staff_cancelled, checks_failed, no_purchasable_orders or stale_automation. Null while it is alive.","type":["string","null"],"enum":["checks_failed","duplicate_plan","no_purchasable_orders","stale_automation","staff_cancelled",null]},"cancellation_message":{"type":["string","null"],"readOnly":true,"description":"Why a cancelled plan closed, in customer terms. Null while the plan is alive. Derived from every check, including the staff-only ones, so the explanation survives without naming a check the caller cannot see."},"blocked":{"type":"boolean","readOnly":true,"description":"True when the plan is alive but a failed check stops it from purchasing until someone acts; see `checks`. False for cancelled and completed plans."},"status":{"readOnly":true,"type":"string","enum":["new","reviewed","scheduled","completed","draft","needs_review","in_progress","cancelled"]}},"required":["blocked","cancellation_message","cancellation_reason","cancelled_at","created_at","executed_via","id","name","status","submitted_at"],"additionalProperties":false}}}} ``` ## The ExecutePurchasePolicyDump\_Exclude\_Segment\_TargetPlan object ```json {"openapi":"3.1.0","info":{"title":"Archera.ai Channel Partner API","version":"v1.0.0"},"components":{"schemas":{"ExecutePurchasePolicyDump_Exclude_Segment_TargetPlan":{"type":"object","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"org_id":{"type":"string","format":"uuid","readOnly":true},"name":{"type":"string","readOnly":true},"description":{"type":["string","null"],"readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"last_modified":{"type":["string","null"],"format":"date-time","readOnly":true},"schedule":{"type":"string","enum":["quarterly","weekly","monthly","daily"],"readOnly":true},"start_date":{"type":["string","null"],"format":"date-time","readOnly":true},"end_date":{"type":["string","null"],"format":"date-time","readOnly":true},"enabled":{"type":"boolean","readOnly":true},"next_execution_date":{"type":["string","null"],"format":"date-time","readOnly":true},"meta_plan_id":{"type":["string","null"],"format":"uuid","readOnly":true},"segment_id":{"type":["string","null"],"format":"uuid","readOnly":true},"default_plan_name":{"type":["string","null"],"readOnly":true},"min_savings":{"type":["number","null"],"readOnly":true},"meta_plan":{"readOnly":true,"$ref":"#/components/schemas/MetaPlanInfo"},"created_by":{"readOnly":true,"$ref":"#/components/schemas/UserInfo"},"plans":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/PlanInfo"}},"total_savings":{"type":["number","null"],"readOnly":true}},"required":["created_at","created_by","default_plan_name","description","enabled","end_date","id","last_modified","meta_plan","meta_plan_id","min_savings","name","next_execution_date","org_id","plans","schedule","segment_id","start_date","total_savings"],"additionalProperties":false},"MetaPlanInfo":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"is_default":{"type":"boolean","readOnly":true}},"required":["created_at","id","is_default","name"],"additionalProperties":false},"UserInfo":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"maxLength":50},"username":{"type":"string","maxLength":255},"full_name":{"type":["string","null"],"maxLength":255}},"required":["username"],"additionalProperties":false},"PlanInfo":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"executed_via":{"readOnly":true,"description":"How the plan was submitted. `automation` means a policy applied it rather than a person, which is what lets a client hide routine automated churn.","type":["string","null"],"enum":["user","agent_in_app","agent_slack","mcp","api","partner","automation",null]},"submitted_at":{"type":["string","null"],"format":"date-time","readOnly":true,"description":"When the plan was submitted for purchase. Null while it is a draft. Archera executes submitted plans within 5 business days, so this is the clock a 'where is my purchase' question is measured against."},"cancelled_at":{"type":["string","null"],"format":"date-time","readOnly":true,"description":"When the plan was cancelled; null while it is alive."},"cancellation_reason":{"readOnly":true,"description":"Why the plan was cancelled: checks_failed, staff_cancelled, checks_failed, no_purchasable_orders or stale_automation. Null while it is alive.","type":["string","null"],"enum":["checks_failed","duplicate_plan","no_purchasable_orders","stale_automation","staff_cancelled",null]},"cancellation_message":{"type":["string","null"],"readOnly":true,"description":"Why a cancelled plan closed, in customer terms. Null while the plan is alive. Derived from every check, including the staff-only ones, so the explanation survives without naming a check the caller cannot see."},"blocked":{"type":"boolean","readOnly":true,"description":"True when the plan is alive but a failed check stops it from purchasing until someone acts; see `checks`. False for cancelled and completed plans."},"status":{"readOnly":true,"type":"string","enum":["new","reviewed","scheduled","completed","draft","needs_review","in_progress","cancelled"]}},"required":["blocked","cancellation_message","cancellation_reason","cancelled_at","created_at","executed_via","id","name","status","submitted_at"],"additionalProperties":false}}}} ``` ## The SegmentInfo object ```json {"openapi":"3.1.0","info":{"title":"Archera.ai Channel Partner API","version":"v1.0.0"},"components":{"schemas":{"SegmentInfo":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"is_default":{"type":"boolean","readOnly":true},"provider":{"readOnly":true,"type":"string","enum":["aws","azure","gcp"]}},"required":["created_at","id","is_default","name","provider"],"additionalProperties":false}}}} ``` ## The PurchasePlanV2NameId object ```json {"openapi":"3.1.0","info":{"title":"Archera.ai Channel Partner API","version":"v1.0.0"},"components":{"schemas":{"PurchasePlanV2NameId":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"is_default":{"type":"boolean"},"status":{"type":"string","enum":["new","reviewed","scheduled","completed","draft","needs_review","in_progress","cancelled"]}},"required":["id","is_default","name","status"],"additionalProperties":false}}}} ``` ## The PurchaseAction\_Exclude\_User object ```json {"openapi":"3.1.0","info":{"title":"Archera.ai Channel Partner API","version":"v1.0.0"},"components":{"schemas":{"PurchaseAction_Exclude_User":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"maxLength":50},"org_id":{"type":["string","null"],"readOnly":true,"maxLength":50},"user_id":{"type":["string","null"],"readOnly":true,"maxLength":50},"provider":{"type":["string","null"],"maxLength":255},"action_type":{"type":["string","null"],"maxLength":255},"action_description":{},"status":{"type":["string","null"],"default":"submitted","maxLength":255},"creation_time":{"type":"string","format":"date-time","readOnly":true},"execution_time":{"type":["string","null"],"format":"date-time","readOnly":true},"execution_info":{"readOnly":true},"plan_id":{"type":"string","readOnly":true,"pattern":"[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}\\Z"},"plan":{"readOnly":true,"$ref":"#/components/schemas/PurchasePlanV2NameId"}},"required":["plan_id"],"additionalProperties":false},"PurchasePlanV2NameId":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"is_default":{"type":"boolean"},"status":{"type":"string","enum":["new","reviewed","scheduled","completed","draft","needs_review","in_progress","cancelled"]}},"required":["id","is_default","name","status"],"additionalProperties":false}}}} ``` ## The RenewalPurchaseAction\_Exclude\_User object ```json {"openapi":"3.1.0","info":{"title":"Archera.ai Channel Partner API","version":"v1.0.0"},"components":{"schemas":{"RenewalPurchaseAction_Exclude_User":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"maxLength":50},"org_id":{"type":["string","null"],"readOnly":true,"maxLength":50},"user_id":{"type":["string","null"],"readOnly":true,"maxLength":50},"provider":{"type":["string","null"],"maxLength":255},"action_type":{"type":["string","null"],"maxLength":255},"action_description":{},"status":{"type":["string","null"],"default":"submitted","maxLength":255},"creation_time":{"type":"string","format":"date-time","readOnly":true},"execution_time":{"type":["string","null"],"format":"date-time","readOnly":true},"execution_info":{"readOnly":true},"plan_id":{"type":"string","readOnly":true,"pattern":"[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}\\Z"},"plan":{"readOnly":true,"$ref":"#/components/schemas/PurchasePlanV2NameId"}},"required":["plan_id"],"additionalProperties":false},"PurchasePlanV2NameId":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"is_default":{"type":"boolean"},"status":{"type":"string","enum":["new","reviewed","scheduled","completed","draft","needs_review","in_progress","cancelled"]}},"required":["id","is_default","name","status"],"additionalProperties":false}}}} ``` ## The ExchangeAction\_Exclude\_User object ```json {"openapi":"3.1.0","info":{"title":"Archera.ai Channel Partner API","version":"v1.0.0"},"components":{"schemas":{"ExchangeAction_Exclude_User":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"maxLength":50},"org_id":{"type":["string","null"],"readOnly":true,"maxLength":50},"user_id":{"type":["string","null"],"readOnly":true,"maxLength":50},"provider":{"type":["string","null"],"maxLength":255},"action_type":{"type":["string","null"],"maxLength":255},"action_description":{},"status":{"type":["string","null"],"default":"submitted","maxLength":255},"creation_time":{"type":"string","format":"date-time","readOnly":true},"execution_time":{"type":["string","null"],"format":"date-time","readOnly":true},"execution_info":{"readOnly":true},"exchange_status":{"type":["string","null"],"maxLength":255}},"additionalProperties":false}}}} ``` ## The LegacyPurchaseAction\_Exclude\_User object ```json {"openapi":"3.1.0","info":{"title":"Archera.ai Channel Partner API","version":"v1.0.0"},"components":{"schemas":{"LegacyPurchaseAction_Exclude_User":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"maxLength":50},"org_id":{"type":["string","null"],"readOnly":true,"maxLength":50},"user_id":{"type":["string","null"],"readOnly":true,"maxLength":50},"provider":{"type":["string","null"],"maxLength":255},"action_type":{"type":["string","null"],"maxLength":255},"action_description":{},"status":{"type":["string","null"],"default":"submitted","maxLength":255},"creation_time":{"type":"string","format":"date-time","readOnly":true},"execution_time":{"type":["string","null"],"format":"date-time","readOnly":true},"execution_info":{"readOnly":true}},"additionalProperties":false}}}} ``` ## The FlaggedAction object ```json {"openapi":"3.1.0","info":{"title":"Archera.ai Channel Partner API","version":"v1.0.0"},"components":{"schemas":{"FlaggedAction":{"oneOf":[{"$ref":"#/components/schemas/PurchaseAction_Exclude_User"},{"$ref":"#/components/schemas/RenewalPurchaseAction_Exclude_User"},{"$ref":"#/components/schemas/ExchangeAction_Exclude_User"},{"$ref":"#/components/schemas/LegacyPurchaseAction_Exclude_User"}],"discriminator":{"propertyName":"action_type","mapping":{"purchase":"#/components/schemas/PurchaseAction_Exclude_User","renewal_purchase":"#/components/schemas/RenewalPurchaseAction_Exclude_User","exchange":"#/components/schemas/ExchangeAction_Exclude_User","legacy_purchase":"#/components/schemas/LegacyPurchaseAction_Exclude_User"}}},"PurchaseAction_Exclude_User":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"maxLength":50},"org_id":{"type":["string","null"],"readOnly":true,"maxLength":50},"user_id":{"type":["string","null"],"readOnly":true,"maxLength":50},"provider":{"type":["string","null"],"maxLength":255},"action_type":{"type":["string","null"],"maxLength":255},"action_description":{},"status":{"type":["string","null"],"default":"submitted","maxLength":255},"creation_time":{"type":"string","format":"date-time","readOnly":true},"execution_time":{"type":["string","null"],"format":"date-time","readOnly":true},"execution_info":{"readOnly":true},"plan_id":{"type":"string","readOnly":true,"pattern":"[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}\\Z"},"plan":{"readOnly":true,"$ref":"#/components/schemas/PurchasePlanV2NameId"}},"required":["plan_id"],"additionalProperties":false},"PurchasePlanV2NameId":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"is_default":{"type":"boolean"},"status":{"type":"string","enum":["new","reviewed","scheduled","completed","draft","needs_review","in_progress","cancelled"]}},"required":["id","is_default","name","status"],"additionalProperties":false},"RenewalPurchaseAction_Exclude_User":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"maxLength":50},"org_id":{"type":["string","null"],"readOnly":true,"maxLength":50},"user_id":{"type":["string","null"],"readOnly":true,"maxLength":50},"provider":{"type":["string","null"],"maxLength":255},"action_type":{"type":["string","null"],"maxLength":255},"action_description":{},"status":{"type":["string","null"],"default":"submitted","maxLength":255},"creation_time":{"type":"string","format":"date-time","readOnly":true},"execution_time":{"type":["string","null"],"format":"date-time","readOnly":true},"execution_info":{"readOnly":true},"plan_id":{"type":"string","readOnly":true,"pattern":"[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}\\Z"},"plan":{"readOnly":true,"$ref":"#/components/schemas/PurchasePlanV2NameId"}},"required":["plan_id"],"additionalProperties":false},"ExchangeAction_Exclude_User":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"maxLength":50},"org_id":{"type":["string","null"],"readOnly":true,"maxLength":50},"user_id":{"type":["string","null"],"readOnly":true,"maxLength":50},"provider":{"type":["string","null"],"maxLength":255},"action_type":{"type":["string","null"],"maxLength":255},"action_description":{},"status":{"type":["string","null"],"default":"submitted","maxLength":255},"creation_time":{"type":"string","format":"date-time","readOnly":true},"execution_time":{"type":["string","null"],"format":"date-time","readOnly":true},"execution_info":{"readOnly":true},"exchange_status":{"type":["string","null"],"maxLength":255}},"additionalProperties":false},"LegacyPurchaseAction_Exclude_User":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"maxLength":50},"org_id":{"type":["string","null"],"readOnly":true,"maxLength":50},"user_id":{"type":["string","null"],"readOnly":true,"maxLength":50},"provider":{"type":["string","null"],"maxLength":255},"action_type":{"type":["string","null"],"maxLength":255},"action_description":{},"status":{"type":["string","null"],"default":"submitted","maxLength":255},"creation_time":{"type":"string","format":"date-time","readOnly":true},"execution_time":{"type":["string","null"],"format":"date-time","readOnly":true},"execution_info":{"readOnly":true}},"additionalProperties":false}}}} ``` ## The CommitmentSummary object ```json {"openapi":"3.1.0","info":{"title":"Archera.ai Channel Partner API","version":"v1.0.0"},"components":{"schemas":{"CommitmentSummary":{"type":"object","properties":{"key":{"type":"string"},"name":{"type":"string"},"provider":{"type":["string","null"],"enum":["aws","azure","gcp",null]},"service_name":{"type":"string"},"num_commitments":{"type":"integer"},"min_commitment":{"type":"number"},"max_savings":{"type":"number"},"min_savings":{"type":"number"},"upfront_cost":{"type":"number"},"monthly_savings":{"type":"number"},"monthly_commitment":{"type":"number"},"potential_coverage":{"type":"number"},"current_coverage":{"type":"number"},"min_term_hours":{"type":"integer"},"max_term_hours":{"type":"integer"},"gri_premium":{"type":"number"}},"required":["key"],"additionalProperties":false}}}} ``` ## The AggregateMetrics object ```json {"openapi":"3.1.0","info":{"title":"Archera.ai Channel Partner API","version":"v1.0.0"},"components":{"schemas":{"AggregateMetrics":{"type":"object","properties":{"potential_coverage":{"type":"number"},"current_coverage":{"type":"number"},"summaries":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/CommitmentSummary"}}},"additionalProperties":false},"CommitmentSummary":{"type":"object","properties":{"key":{"type":"string"},"name":{"type":"string"},"provider":{"type":["string","null"],"enum":["aws","azure","gcp",null]},"service_name":{"type":"string"},"num_commitments":{"type":"integer"},"min_commitment":{"type":"number"},"max_savings":{"type":"number"},"min_savings":{"type":"number"},"upfront_cost":{"type":"number"},"monthly_savings":{"type":"number"},"monthly_commitment":{"type":"number"},"potential_coverage":{"type":"number"},"current_coverage":{"type":"number"},"min_term_hours":{"type":"integer"},"max_term_hours":{"type":"integer"},"gri_premium":{"type":"number"}},"required":["key"],"additionalProperties":false}}}} ``` ## The LineItemSummary object ```json {"openapi":"3.1.0","info":{"title":"Archera.ai Channel Partner API","version":"v1.0.0"},"components":{"schemas":{"LineItemSummary":{"type":"object","properties":{"key":{"type":"string"},"provider":{"type":"string","enum":["aws","azure","gcp"]},"num_commitments":{"type":"integer"},"min_commitment":{"type":"number"},"max_savings":{"type":"number"},"min_savings":{"type":"number"},"upfront_cost":{"type":"number"},"monthly_savings":{"type":"number"},"monthly_commitment":{"type":"number"},"min_term_hours":{"type":"integer"},"max_term_hours":{"type":"integer"},"gri_premiums":{"type":"number"},"if_all_ondemand_cost":{"type":"number"},"before_ondemand_cost":{"type":"number"},"after_ondemand_cost":{"type":"number"}},"required":["after_ondemand_cost","before_ondemand_cost","gri_premiums","if_all_ondemand_cost","key","max_savings","max_term_hours","min_commitment","min_savings","min_term_hours","monthly_commitment","monthly_savings","num_commitments","provider","upfront_cost"],"additionalProperties":false}}}} ``` ## The PurchasePlanV2CombinedSummary object ```json {"openapi":"3.1.0","info":{"title":"Archera.ai Channel Partner API","version":"v1.0.0"},"components":{"schemas":{"PurchasePlanV2CombinedSummary":{"type":"object","properties":{"executed_via":{"readOnly":true,"description":"How the plan was submitted. `automation` means a policy applied it rather than a person, which is what lets a client hide routine automated churn.","type":["string","null"],"enum":["user","agent_in_app","agent_slack","mcp","api","partner","automation",null]},"submitted_at":{"type":["string","null"],"format":"date-time","readOnly":true,"description":"When the plan was submitted for purchase. Null while it is a draft. Archera executes submitted plans within 5 business days, so this is the clock a 'where is my purchase' question is measured against."},"cancelled_at":{"type":["string","null"],"format":"date-time","readOnly":true,"description":"When the plan was cancelled; null while it is alive."},"cancellation_reason":{"readOnly":true,"description":"Why the plan was cancelled: checks_failed, staff_cancelled, checks_failed, no_purchasable_orders or stale_automation. Null while it is alive.","type":["string","null"],"enum":["checks_failed","duplicate_plan","no_purchasable_orders","stale_automation","staff_cancelled",null]},"cancellation_message":{"type":["string","null"],"readOnly":true,"description":"Why a cancelled plan closed, in customer terms. Null while the plan is alive. Derived from every check, including the staff-only ones, so the explanation survives without naming a check the caller cannot see."},"blocked":{"type":"boolean","readOnly":true,"description":"True when the plan is alive but a failed check stops it from purchasing until someone acts; see `checks`. False for cancelled and completed plans."},"start_date":{"type":["string","null"],"format":"date-time"},"end_date":{"type":["string","null"],"format":"date-time"},"id":{"type":"string","format":"uuid"},"data_source":{"type":"string","maxLength":20},"name":{"type":"string"},"description":{"type":["string","null"]},"segment_id":{"type":"string","maxLength":50},"meta_plan_id":{"type":["string","null"],"format":"uuid"},"org_id":{"type":"string","maxLength":50},"last_modified":{"type":["string","null"],"format":"date-time"},"plan_type":{"type":"string","enum":["purchase","renewal","infrastructure"]},"coverage_id":{"type":["string","null"],"format":"uuid"},"created_at":{"type":"string","format":"date-time"},"is_calculating":{"type":"boolean"},"is_saved":{"type":"boolean"},"is_locked":{"type":"boolean"},"max_upfront_cost":{"type":"number"},"minimum_upfront_interest_rate":{"type":"number"},"preferred_payment_option":{"enum":["No Upfront","Partial Upfront","All Upfront",null]},"included_contract_specs":{"type":"array","items":{"$ref":"#/components/schemas/PurchasePlanContractSpec"}},"included_contract_terms":{"type":"array","items":{"type":"string","enum":["one_year_gris","thirty_day_gris","two_month_gris","three_month_gris","four_month_gris","five_month_gris","six_month_gris","seven_month_gris","eight_month_gris","nine_month_gris","ten_month_gris","eleven_month_gris","twelve_month_gris","thirteen_month_gris","fourteen_month_gris","fifteen_month_gris","sixteen_month_gris","seventeen_month_gris","eighteen_month_gris","nineteen_month_gris","twenty_month_gris","twenty_one_month_gris","twenty_two_month_gris","twenty_three_month_gris","twenty_four_month_gris","twenty_five_month_gris","twenty_six_month_gris","twenty_seven_month_gris","twenty_eight_month_gris","twenty_nine_month_gris","thirty_month_gris","thirty_one_month_gris","thirty_two_month_gris","thirty_three_month_gris","thirty_four_month_gris","thirty_five_month_gris","one_year","two_year","three_year","five_year","zero_day","thirty_day","two_month","three_month","four_month","five_month","six_month","seven_month","eight_month","nine_month","ten_month","eleven_month","thirteen_month","fourteen_month","fifteen_month","sixteen_month","seventeen_month","eighteen_month","nineteen_month","twenty_month","twenty_one_month","twenty_two_month","twenty_three_month","twenty_five_month","twenty_six_month","twenty_seven_month","twenty_eight_month","twenty_nine_month","thirty_month","thirty_one_month","thirty_two_month","thirty_three_month","thirty_four_month","thirty_five_month"]}},"recommend_within_covered_accounts":{"type":["boolean","null"]},"status":{"type":"string","enum":["new","reviewed","scheduled","completed","draft","needs_review","in_progress","cancelled"]},"is_recommended":{"type":"boolean"},"is_default":{"type":"boolean"},"is_renewal":{"type":"boolean"},"is_cost_estimate_plan":{"type":"boolean"},"source_cost_estimate_id":{"type":["string","null"],"format":"uuid","description":"Cost estimate this plan was generated from (data_source = 'cost_estimate'); SET NULL survives estimate deletion."},"source_cost_estimate":{"anyOf":[{"$ref":"#/components/schemas/CostEstimateSource"},{"type":"null"}]},"execution_policy":{"$ref":"#/components/schemas/ExecutePurchasePolicyDump_Exclude_Segment_TargetPlan"},"segment":{"$ref":"#/components/schemas/SegmentInfo"},"flagged_actions":{"type":"array","items":{"$ref":"#/components/schemas/FlaggedAction"}},"created_by":{"$ref":"#/components/schemas/UserInfo"},"resource_ids":{"type":"array","items":{"type":"string"}},"reservation_ids":{"type":"array","items":{"type":"string"}},"max_term":{"type":"string"},"all_terms":{"type":"array","items":{"type":"string","enum":["one_year_gris","thirty_day_gris","two_month_gris","three_month_gris","four_month_gris","five_month_gris","six_month_gris","seven_month_gris","eight_month_gris","nine_month_gris","ten_month_gris","eleven_month_gris","twelve_month_gris","thirteen_month_gris","fourteen_month_gris","fifteen_month_gris","sixteen_month_gris","seventeen_month_gris","eighteen_month_gris","nineteen_month_gris","twenty_month_gris","twenty_one_month_gris","twenty_two_month_gris","twenty_three_month_gris","twenty_four_month_gris","twenty_five_month_gris","twenty_six_month_gris","twenty_seven_month_gris","twenty_eight_month_gris","twenty_nine_month_gris","thirty_month_gris","thirty_one_month_gris","thirty_two_month_gris","thirty_three_month_gris","thirty_four_month_gris","thirty_five_month_gris","one_year","two_year","three_year","five_year","zero_day","thirty_day","two_month","three_month","four_month","five_month","six_month","seven_month","eight_month","nine_month","ten_month","eleven_month","thirteen_month","fourteen_month","fifteen_month","sixteen_month","seventeen_month","eighteen_month","nineteen_month","twenty_month","twenty_one_month","twenty_two_month","twenty_three_month","twenty_five_month","twenty_six_month","twenty_seven_month","twenty_eight_month","twenty_nine_month","thirty_month","thirty_one_month","thirty_two_month","thirty_three_month","thirty_four_month","thirty_five_month"]}},"covered_ondemand_cost":{"type":"number"},"before_ondemand_cost":{"type":"number"},"before_reserved_cost":{"type":"number"},"amortized_cost":{"type":"number"},"recurring_cost":{"type":"number"},"upfront_cost":{"type":"number"},"before_cost":{"type":"number"},"after_cost":{"type":"number"},"total_cost":{"type":"number"},"savings":{"type":"number"},"fee":{"type":"number"},"commitment_coverage":{"type":"number"},"minimum_commitment_cost":{"type":"number"},"breakeven_hours":{"type":"number"},"total_savings":{"type":"number"},"monthly_savings":{"type":"number"},"monthly_amortized_cost":{"type":"number"},"monthly_fee":{"type":"number"},"monthly_before_cost":{"type":"number"},"monthly_after_cost":{"type":"number"},"total_monthly_before_cost":{"type":"number"},"aggregate_metrics":{"$ref":"#/components/schemas/AggregateMetrics"},"summaries":{"type":"array","items":{"$ref":"#/components/schemas/LineItemSummary"}}},"required":["after_cost","all_terms","amortized_cost","before_cost","before_ondemand_cost","before_reserved_cost","blocked","breakeven_hours","cancellation_message","cancellation_reason","cancelled_at","commitment_coverage","coverage_id","covered_ondemand_cost","created_at","created_by","data_source","description","executed_via","execution_policy","fee","flagged_actions","id","included_contract_specs","included_contract_terms","is_calculating","is_cost_estimate_plan","is_default","is_locked","is_recommended","is_renewal","is_saved","last_modified","max_term","max_upfront_cost","meta_plan_id","minimum_commitment_cost","minimum_upfront_interest_rate","monthly_after_cost","monthly_amortized_cost","monthly_before_cost","monthly_fee","monthly_savings","name","org_id","plan_type","preferred_payment_option","recommend_within_covered_accounts","recurring_cost","reservation_ids","resource_ids","savings","segment","segment_id","source_cost_estimate","source_cost_estimate_id","status","submitted_at","summaries","total_cost","total_monthly_before_cost","total_savings","upfront_cost"],"additionalProperties":false},"PurchasePlanContractSpec":{"type":"object","properties":{"commitment_type":{"type":"string"},"properties":{"type":"object","default":{},"additionalProperties":{}},"term":{"default":null,"type":["string","null"],"enum":["one_year_gris","thirty_day_gris","two_month_gris","three_month_gris","four_month_gris","five_month_gris","six_month_gris","seven_month_gris","eight_month_gris","nine_month_gris","ten_month_gris","eleven_month_gris","twelve_month_gris","thirteen_month_gris","fourteen_month_gris","fifteen_month_gris","sixteen_month_gris","seventeen_month_gris","eighteen_month_gris","nineteen_month_gris","twenty_month_gris","twenty_one_month_gris","twenty_two_month_gris","twenty_three_month_gris","twenty_four_month_gris","twenty_five_month_gris","twenty_six_month_gris","twenty_seven_month_gris","twenty_eight_month_gris","twenty_nine_month_gris","thirty_month_gris","thirty_one_month_gris","thirty_two_month_gris","thirty_three_month_gris","thirty_four_month_gris","thirty_five_month_gris","one_year","two_year","three_year","five_year","zero_day","thirty_day","two_month","three_month","four_month","five_month","six_month","seven_month","eight_month","nine_month","ten_month","eleven_month","thirteen_month","fourteen_month","fifteen_month","sixteen_month","seventeen_month","eighteen_month","nineteen_month","twenty_month","twenty_one_month","twenty_two_month","twenty_three_month","twenty_five_month","twenty_six_month","twenty_seven_month","twenty_eight_month","twenty_nine_month","thirty_month","thirty_one_month","thirty_two_month","thirty_three_month","thirty_four_month","thirty_five_month",null]},"payment_option":{"default":null,"type":["string","null"],"enum":["no_upfront","partial_upfront","all_upfront",null]}},"required":["commitment_type"],"additionalProperties":false},"CostEstimateSource":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"updated_at":{"type":"string","format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["deleted_at","id","name","updated_at"],"additionalProperties":false},"ExecutePurchasePolicyDump_Exclude_Segment_TargetPlan":{"type":"object","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"org_id":{"type":"string","format":"uuid","readOnly":true},"name":{"type":"string","readOnly":true},"description":{"type":["string","null"],"readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"last_modified":{"type":["string","null"],"format":"date-time","readOnly":true},"schedule":{"type":"string","enum":["quarterly","weekly","monthly","daily"],"readOnly":true},"start_date":{"type":["string","null"],"format":"date-time","readOnly":true},"end_date":{"type":["string","null"],"format":"date-time","readOnly":true},"enabled":{"type":"boolean","readOnly":true},"next_execution_date":{"type":["string","null"],"format":"date-time","readOnly":true},"meta_plan_id":{"type":["string","null"],"format":"uuid","readOnly":true},"segment_id":{"type":["string","null"],"format":"uuid","readOnly":true},"default_plan_name":{"type":["string","null"],"readOnly":true},"min_savings":{"type":["number","null"],"readOnly":true},"meta_plan":{"readOnly":true,"$ref":"#/components/schemas/MetaPlanInfo"},"created_by":{"readOnly":true,"$ref":"#/components/schemas/UserInfo"},"plans":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/PlanInfo"}},"total_savings":{"type":["number","null"],"readOnly":true}},"required":["created_at","created_by","default_plan_name","description","enabled","end_date","id","last_modified","meta_plan","meta_plan_id","min_savings","name","next_execution_date","org_id","plans","schedule","segment_id","start_date","total_savings"],"additionalProperties":false},"MetaPlanInfo":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"is_default":{"type":"boolean","readOnly":true}},"required":["created_at","id","is_default","name"],"additionalProperties":false},"UserInfo":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"maxLength":50},"username":{"type":"string","maxLength":255},"full_name":{"type":["string","null"],"maxLength":255}},"required":["username"],"additionalProperties":false},"PlanInfo":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"executed_via":{"readOnly":true,"description":"How the plan was submitted. `automation` means a policy applied it rather than a person, which is what lets a client hide routine automated churn.","type":["string","null"],"enum":["user","agent_in_app","agent_slack","mcp","api","partner","automation",null]},"submitted_at":{"type":["string","null"],"format":"date-time","readOnly":true,"description":"When the plan was submitted for purchase. Null while it is a draft. Archera executes submitted plans within 5 business days, so this is the clock a 'where is my purchase' question is measured against."},"cancelled_at":{"type":["string","null"],"format":"date-time","readOnly":true,"description":"When the plan was cancelled; null while it is alive."},"cancellation_reason":{"readOnly":true,"description":"Why the plan was cancelled: checks_failed, staff_cancelled, checks_failed, no_purchasable_orders or stale_automation. Null while it is alive.","type":["string","null"],"enum":["checks_failed","duplicate_plan","no_purchasable_orders","stale_automation","staff_cancelled",null]},"cancellation_message":{"type":["string","null"],"readOnly":true,"description":"Why a cancelled plan closed, in customer terms. Null while the plan is alive. Derived from every check, including the staff-only ones, so the explanation survives without naming a check the caller cannot see."},"blocked":{"type":"boolean","readOnly":true,"description":"True when the plan is alive but a failed check stops it from purchasing until someone acts; see `checks`. False for cancelled and completed plans."},"status":{"readOnly":true,"type":"string","enum":["new","reviewed","scheduled","completed","draft","needs_review","in_progress","cancelled"]}},"required":["blocked","cancellation_message","cancellation_reason","cancelled_at","created_at","executed_via","id","name","status","submitted_at"],"additionalProperties":false},"SegmentInfo":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"is_default":{"type":"boolean","readOnly":true},"provider":{"readOnly":true,"type":"string","enum":["aws","azure","gcp"]}},"required":["created_at","id","is_default","name","provider"],"additionalProperties":false},"FlaggedAction":{"oneOf":[{"$ref":"#/components/schemas/PurchaseAction_Exclude_User"},{"$ref":"#/components/schemas/RenewalPurchaseAction_Exclude_User"},{"$ref":"#/components/schemas/ExchangeAction_Exclude_User"},{"$ref":"#/components/schemas/LegacyPurchaseAction_Exclude_User"}],"discriminator":{"propertyName":"action_type","mapping":{"purchase":"#/components/schemas/PurchaseAction_Exclude_User","renewal_purchase":"#/components/schemas/RenewalPurchaseAction_Exclude_User","exchange":"#/components/schemas/ExchangeAction_Exclude_User","legacy_purchase":"#/components/schemas/LegacyPurchaseAction_Exclude_User"}}},"PurchaseAction_Exclude_User":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"maxLength":50},"org_id":{"type":["string","null"],"readOnly":true,"maxLength":50},"user_id":{"type":["string","null"],"readOnly":true,"maxLength":50},"provider":{"type":["string","null"],"maxLength":255},"action_type":{"type":["string","null"],"maxLength":255},"action_description":{},"status":{"type":["string","null"],"default":"submitted","maxLength":255},"creation_time":{"type":"string","format":"date-time","readOnly":true},"execution_time":{"type":["string","null"],"format":"date-time","readOnly":true},"execution_info":{"readOnly":true},"plan_id":{"type":"string","readOnly":true,"pattern":"[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}\\Z"},"plan":{"readOnly":true,"$ref":"#/components/schemas/PurchasePlanV2NameId"}},"required":["plan_id"],"additionalProperties":false},"PurchasePlanV2NameId":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"is_default":{"type":"boolean"},"status":{"type":"string","enum":["new","reviewed","scheduled","completed","draft","needs_review","in_progress","cancelled"]}},"required":["id","is_default","name","status"],"additionalProperties":false},"RenewalPurchaseAction_Exclude_User":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"maxLength":50},"org_id":{"type":["string","null"],"readOnly":true,"maxLength":50},"user_id":{"type":["string","null"],"readOnly":true,"maxLength":50},"provider":{"type":["string","null"],"maxLength":255},"action_type":{"type":["string","null"],"maxLength":255},"action_description":{},"status":{"type":["string","null"],"default":"submitted","maxLength":255},"creation_time":{"type":"string","format":"date-time","readOnly":true},"execution_time":{"type":["string","null"],"format":"date-time","readOnly":true},"execution_info":{"readOnly":true},"plan_id":{"type":"string","readOnly":true,"pattern":"[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}\\Z"},"plan":{"readOnly":true,"$ref":"#/components/schemas/PurchasePlanV2NameId"}},"required":["plan_id"],"additionalProperties":false},"ExchangeAction_Exclude_User":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"maxLength":50},"org_id":{"type":["string","null"],"readOnly":true,"maxLength":50},"user_id":{"type":["string","null"],"readOnly":true,"maxLength":50},"provider":{"type":["string","null"],"maxLength":255},"action_type":{"type":["string","null"],"maxLength":255},"action_description":{},"status":{"type":["string","null"],"default":"submitted","maxLength":255},"creation_time":{"type":"string","format":"date-time","readOnly":true},"execution_time":{"type":["string","null"],"format":"date-time","readOnly":true},"execution_info":{"readOnly":true},"exchange_status":{"type":["string","null"],"maxLength":255}},"additionalProperties":false},"LegacyPurchaseAction_Exclude_User":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"maxLength":50},"org_id":{"type":["string","null"],"readOnly":true,"maxLength":50},"user_id":{"type":["string","null"],"readOnly":true,"maxLength":50},"provider":{"type":["string","null"],"maxLength":255},"action_type":{"type":["string","null"],"maxLength":255},"action_description":{},"status":{"type":["string","null"],"default":"submitted","maxLength":255},"creation_time":{"type":"string","format":"date-time","readOnly":true},"execution_time":{"type":["string","null"],"format":"date-time","readOnly":true},"execution_info":{"readOnly":true}},"additionalProperties":false},"AggregateMetrics":{"type":"object","properties":{"potential_coverage":{"type":"number"},"current_coverage":{"type":"number"},"summaries":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/CommitmentSummary"}}},"additionalProperties":false},"CommitmentSummary":{"type":"object","properties":{"key":{"type":"string"},"name":{"type":"string"},"provider":{"type":["string","null"],"enum":["aws","azure","gcp",null]},"service_name":{"type":"string"},"num_commitments":{"type":"integer"},"min_commitment":{"type":"number"},"max_savings":{"type":"number"},"min_savings":{"type":"number"},"upfront_cost":{"type":"number"},"monthly_savings":{"type":"number"},"monthly_commitment":{"type":"number"},"potential_coverage":{"type":"number"},"current_coverage":{"type":"number"},"min_term_hours":{"type":"integer"},"max_term_hours":{"type":"integer"},"gri_premium":{"type":"number"}},"required":["key"],"additionalProperties":false},"LineItemSummary":{"type":"object","properties":{"key":{"type":"string"},"provider":{"type":"string","enum":["aws","azure","gcp"]},"num_commitments":{"type":"integer"},"min_commitment":{"type":"number"},"max_savings":{"type":"number"},"min_savings":{"type":"number"},"upfront_cost":{"type":"number"},"monthly_savings":{"type":"number"},"monthly_commitment":{"type":"number"},"min_term_hours":{"type":"integer"},"max_term_hours":{"type":"integer"},"gri_premiums":{"type":"number"},"if_all_ondemand_cost":{"type":"number"},"before_ondemand_cost":{"type":"number"},"after_ondemand_cost":{"type":"number"}},"required":["after_ondemand_cost","before_ondemand_cost","gri_premiums","if_all_ondemand_cost","key","max_savings","max_term_hours","min_commitment","min_savings","min_term_hours","monthly_commitment","monthly_savings","num_commitments","provider","upfront_cost"],"additionalProperties":false}}}} ``` ## The PurchaseRequest object ```json {"openapi":"3.1.0","info":{"title":"Archera.ai Channel Partner API","version":"v1.0.0"},"components":{"schemas":{"PurchaseRequest":{"type":"object","properties":{"email":{"type":"string","format":"email","maxLength":255,"description":"Email of the user executing the purchase"}},"required":["email"],"additionalProperties":false}}}} ``` ## The PurchasePlanV2 object ```json {"openapi":"3.1.0","info":{"title":"Archera.ai Channel Partner API","version":"v1.0.0"},"components":{"schemas":{"PurchasePlanV2":{"type":"object","properties":{"executed_via":{"readOnly":true,"description":"How the plan was submitted. `automation` means a policy applied it rather than a person, which is what lets a client hide routine automated churn.","type":["string","null"],"enum":["user","agent_in_app","agent_slack","mcp","api","partner","automation",null]},"submitted_at":{"type":["string","null"],"format":"date-time","readOnly":true,"description":"When the plan was submitted for purchase. Null while it is a draft. Archera executes submitted plans within 5 business days, so this is the clock a 'where is my purchase' question is measured against."},"cancelled_at":{"type":["string","null"],"format":"date-time","readOnly":true,"description":"When the plan was cancelled; null while it is alive."},"cancellation_reason":{"readOnly":true,"description":"Why the plan was cancelled: checks_failed, staff_cancelled, checks_failed, no_purchasable_orders or stale_automation. Null while it is alive.","type":["string","null"],"enum":["checks_failed","duplicate_plan","no_purchasable_orders","stale_automation","staff_cancelled",null]},"cancellation_message":{"type":["string","null"],"readOnly":true,"description":"Why a cancelled plan closed, in customer terms. Null while the plan is alive. Derived from every check, including the staff-only ones, so the explanation survives without naming a check the caller cannot see."},"blocked":{"type":"boolean","readOnly":true,"description":"True when the plan is alive but a failed check stops it from purchasing until someone acts; see `checks`. False for cancelled and completed plans."},"start_date":{"type":["string","null"],"format":"date-time"},"end_date":{"type":["string","null"],"format":"date-time"},"id":{"type":"string","format":"uuid"},"data_source":{"type":"string","maxLength":20},"name":{"type":"string"},"description":{"type":["string","null"]},"segment_id":{"type":"string","maxLength":50},"meta_plan_id":{"type":["string","null"],"format":"uuid"},"org_id":{"type":"string","maxLength":50},"last_modified":{"type":["string","null"],"format":"date-time"},"plan_type":{"type":"string","enum":["purchase","renewal","infrastructure"]},"coverage_id":{"type":["string","null"],"format":"uuid"},"created_at":{"type":"string","format":"date-time"},"is_calculating":{"type":"boolean"},"is_saved":{"type":"boolean"},"is_locked":{"type":"boolean"},"max_upfront_cost":{"type":"number"},"minimum_upfront_interest_rate":{"type":"number"},"preferred_payment_option":{"enum":["No Upfront","Partial Upfront","All Upfront",null]},"included_contract_specs":{"type":"array","items":{"$ref":"#/components/schemas/PurchasePlanContractSpec"}},"included_contract_terms":{"type":"array","items":{"type":"string","enum":["one_year_gris","thirty_day_gris","two_month_gris","three_month_gris","four_month_gris","five_month_gris","six_month_gris","seven_month_gris","eight_month_gris","nine_month_gris","ten_month_gris","eleven_month_gris","twelve_month_gris","thirteen_month_gris","fourteen_month_gris","fifteen_month_gris","sixteen_month_gris","seventeen_month_gris","eighteen_month_gris","nineteen_month_gris","twenty_month_gris","twenty_one_month_gris","twenty_two_month_gris","twenty_three_month_gris","twenty_four_month_gris","twenty_five_month_gris","twenty_six_month_gris","twenty_seven_month_gris","twenty_eight_month_gris","twenty_nine_month_gris","thirty_month_gris","thirty_one_month_gris","thirty_two_month_gris","thirty_three_month_gris","thirty_four_month_gris","thirty_five_month_gris","one_year","two_year","three_year","five_year","zero_day","thirty_day","two_month","three_month","four_month","five_month","six_month","seven_month","eight_month","nine_month","ten_month","eleven_month","thirteen_month","fourteen_month","fifteen_month","sixteen_month","seventeen_month","eighteen_month","nineteen_month","twenty_month","twenty_one_month","twenty_two_month","twenty_three_month","twenty_five_month","twenty_six_month","twenty_seven_month","twenty_eight_month","twenty_nine_month","thirty_month","thirty_one_month","thirty_two_month","thirty_three_month","thirty_four_month","thirty_five_month"]}},"recommend_within_covered_accounts":{"type":["boolean","null"]},"status":{"type":"string","enum":["new","reviewed","scheduled","completed","draft","needs_review","in_progress","cancelled"]},"is_recommended":{"type":"boolean"},"is_default":{"type":"boolean"},"is_renewal":{"type":"boolean"},"is_cost_estimate_plan":{"type":"boolean"},"source_cost_estimate_id":{"type":["string","null"],"format":"uuid","description":"Cost estimate this plan was generated from (data_source = 'cost_estimate'); SET NULL survives estimate deletion."},"source_cost_estimate":{"anyOf":[{"$ref":"#/components/schemas/CostEstimateSource"},{"type":"null"}]},"execution_policy":{"$ref":"#/components/schemas/ExecutePurchasePolicyDump_Exclude_Segment_TargetPlan"},"segment":{"$ref":"#/components/schemas/SegmentInfo"},"flagged_actions":{"type":"array","items":{"$ref":"#/components/schemas/FlaggedAction"}},"created_by":{"$ref":"#/components/schemas/UserInfo"},"resource_ids":{"type":"array","items":{"type":"string"}},"reservation_ids":{"type":"array","items":{"type":"string"}}},"required":["blocked","cancellation_message","cancellation_reason","cancelled_at","coverage_id","created_at","created_by","data_source","description","executed_via","execution_policy","flagged_actions","id","included_contract_specs","included_contract_terms","is_calculating","is_cost_estimate_plan","is_default","is_locked","is_recommended","is_renewal","is_saved","last_modified","max_upfront_cost","meta_plan_id","minimum_upfront_interest_rate","name","org_id","plan_type","preferred_payment_option","recommend_within_covered_accounts","reservation_ids","resource_ids","segment","segment_id","source_cost_estimate","source_cost_estimate_id","status","submitted_at"],"additionalProperties":false},"PurchasePlanContractSpec":{"type":"object","properties":{"commitment_type":{"type":"string"},"properties":{"type":"object","default":{},"additionalProperties":{}},"term":{"default":null,"type":["string","null"],"enum":["one_year_gris","thirty_day_gris","two_month_gris","three_month_gris","four_month_gris","five_month_gris","six_month_gris","seven_month_gris","eight_month_gris","nine_month_gris","ten_month_gris","eleven_month_gris","twelve_month_gris","thirteen_month_gris","fourteen_month_gris","fifteen_month_gris","sixteen_month_gris","seventeen_month_gris","eighteen_month_gris","nineteen_month_gris","twenty_month_gris","twenty_one_month_gris","twenty_two_month_gris","twenty_three_month_gris","twenty_four_month_gris","twenty_five_month_gris","twenty_six_month_gris","twenty_seven_month_gris","twenty_eight_month_gris","twenty_nine_month_gris","thirty_month_gris","thirty_one_month_gris","thirty_two_month_gris","thirty_three_month_gris","thirty_four_month_gris","thirty_five_month_gris","one_year","two_year","three_year","five_year","zero_day","thirty_day","two_month","three_month","four_month","five_month","six_month","seven_month","eight_month","nine_month","ten_month","eleven_month","thirteen_month","fourteen_month","fifteen_month","sixteen_month","seventeen_month","eighteen_month","nineteen_month","twenty_month","twenty_one_month","twenty_two_month","twenty_three_month","twenty_five_month","twenty_six_month","twenty_seven_month","twenty_eight_month","twenty_nine_month","thirty_month","thirty_one_month","thirty_two_month","thirty_three_month","thirty_four_month","thirty_five_month",null]},"payment_option":{"default":null,"type":["string","null"],"enum":["no_upfront","partial_upfront","all_upfront",null]}},"required":["commitment_type"],"additionalProperties":false},"CostEstimateSource":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"updated_at":{"type":"string","format":"date-time"},"deleted_at":{"type":["string","null"],"format":"date-time"}},"required":["deleted_at","id","name","updated_at"],"additionalProperties":false},"ExecutePurchasePolicyDump_Exclude_Segment_TargetPlan":{"type":"object","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"org_id":{"type":"string","format":"uuid","readOnly":true},"name":{"type":"string","readOnly":true},"description":{"type":["string","null"],"readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"last_modified":{"type":["string","null"],"format":"date-time","readOnly":true},"schedule":{"type":"string","enum":["quarterly","weekly","monthly","daily"],"readOnly":true},"start_date":{"type":["string","null"],"format":"date-time","readOnly":true},"end_date":{"type":["string","null"],"format":"date-time","readOnly":true},"enabled":{"type":"boolean","readOnly":true},"next_execution_date":{"type":["string","null"],"format":"date-time","readOnly":true},"meta_plan_id":{"type":["string","null"],"format":"uuid","readOnly":true},"segment_id":{"type":["string","null"],"format":"uuid","readOnly":true},"default_plan_name":{"type":["string","null"],"readOnly":true},"min_savings":{"type":["number","null"],"readOnly":true},"meta_plan":{"readOnly":true,"$ref":"#/components/schemas/MetaPlanInfo"},"created_by":{"readOnly":true,"$ref":"#/components/schemas/UserInfo"},"plans":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/PlanInfo"}},"total_savings":{"type":["number","null"],"readOnly":true}},"required":["created_at","created_by","default_plan_name","description","enabled","end_date","id","last_modified","meta_plan","meta_plan_id","min_savings","name","next_execution_date","org_id","plans","schedule","segment_id","start_date","total_savings"],"additionalProperties":false},"MetaPlanInfo":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"is_default":{"type":"boolean","readOnly":true}},"required":["created_at","id","is_default","name"],"additionalProperties":false},"UserInfo":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"maxLength":50},"username":{"type":"string","maxLength":255},"full_name":{"type":["string","null"],"maxLength":255}},"required":["username"],"additionalProperties":false},"PlanInfo":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"executed_via":{"readOnly":true,"description":"How the plan was submitted. `automation` means a policy applied it rather than a person, which is what lets a client hide routine automated churn.","type":["string","null"],"enum":["user","agent_in_app","agent_slack","mcp","api","partner","automation",null]},"submitted_at":{"type":["string","null"],"format":"date-time","readOnly":true,"description":"When the plan was submitted for purchase. Null while it is a draft. Archera executes submitted plans within 5 business days, so this is the clock a 'where is my purchase' question is measured against."},"cancelled_at":{"type":["string","null"],"format":"date-time","readOnly":true,"description":"When the plan was cancelled; null while it is alive."},"cancellation_reason":{"readOnly":true,"description":"Why the plan was cancelled: checks_failed, staff_cancelled, checks_failed, no_purchasable_orders or stale_automation. Null while it is alive.","type":["string","null"],"enum":["checks_failed","duplicate_plan","no_purchasable_orders","stale_automation","staff_cancelled",null]},"cancellation_message":{"type":["string","null"],"readOnly":true,"description":"Why a cancelled plan closed, in customer terms. Null while the plan is alive. Derived from every check, including the staff-only ones, so the explanation survives without naming a check the caller cannot see."},"blocked":{"type":"boolean","readOnly":true,"description":"True when the plan is alive but a failed check stops it from purchasing until someone acts; see `checks`. False for cancelled and completed plans."},"status":{"readOnly":true,"type":"string","enum":["new","reviewed","scheduled","completed","draft","needs_review","in_progress","cancelled"]}},"required":["blocked","cancellation_message","cancellation_reason","cancelled_at","created_at","executed_via","id","name","status","submitted_at"],"additionalProperties":false},"SegmentInfo":{"type":"object","properties":{"id":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"is_default":{"type":"boolean","readOnly":true},"provider":{"readOnly":true,"type":"string","enum":["aws","azure","gcp"]}},"required":["created_at","id","is_default","name","provider"],"additionalProperties":false},"FlaggedAction":{"oneOf":[{"$ref":"#/components/schemas/PurchaseAction_Exclude_User"},{"$ref":"#/components/schemas/RenewalPurchaseAction_Exclude_User"},{"$ref":"#/components/schemas/ExchangeAction_Exclude_User"},{"$ref":"#/components/schemas/LegacyPurchaseAction_Exclude_User"}],"discriminator":{"propertyName":"action_type","mapping":{"purchase":"#/components/schemas/PurchaseAction_Exclude_User","renewal_purchase":"#/components/schemas/RenewalPurchaseAction_Exclude_User","exchange":"#/components/schemas/ExchangeAction_Exclude_User","legacy_purchase":"#/components/schemas/LegacyPurchaseAction_Exclude_User"}}},"PurchaseAction_Exclude_User":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"maxLength":50},"org_id":{"type":["string","null"],"readOnly":true,"maxLength":50},"user_id":{"type":["string","null"],"readOnly":true,"maxLength":50},"provider":{"type":["string","null"],"maxLength":255},"action_type":{"type":["string","null"],"maxLength":255},"action_description":{},"status":{"type":["string","null"],"default":"submitted","maxLength":255},"creation_time":{"type":"string","format":"date-time","readOnly":true},"execution_time":{"type":["string","null"],"format":"date-time","readOnly":true},"execution_info":{"readOnly":true},"plan_id":{"type":"string","readOnly":true,"pattern":"[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}\\Z"},"plan":{"readOnly":true,"$ref":"#/components/schemas/PurchasePlanV2NameId"}},"required":["plan_id"],"additionalProperties":false},"PurchasePlanV2NameId":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string","format":"uuid"},"is_default":{"type":"boolean"},"status":{"type":"string","enum":["new","reviewed","scheduled","completed","draft","needs_review","in_progress","cancelled"]}},"required":["id","is_default","name","status"],"additionalProperties":false},"RenewalPurchaseAction_Exclude_User":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"maxLength":50},"org_id":{"type":["string","null"],"readOnly":true,"maxLength":50},"user_id":{"type":["string","null"],"readOnly":true,"maxLength":50},"provider":{"type":["string","null"],"maxLength":255},"action_type":{"type":["string","null"],"maxLength":255},"action_description":{},"status":{"type":["string","null"],"default":"submitted","maxLength":255},"creation_time":{"type":"string","format":"date-time","readOnly":true},"execution_time":{"type":["string","null"],"format":"date-time","readOnly":true},"execution_info":{"readOnly":true},"plan_id":{"type":"string","readOnly":true,"pattern":"[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}\\Z"},"plan":{"readOnly":true,"$ref":"#/components/schemas/PurchasePlanV2NameId"}},"required":["plan_id"],"additionalProperties":false},"ExchangeAction_Exclude_User":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"maxLength":50},"org_id":{"type":["string","null"],"readOnly":true,"maxLength":50},"user_id":{"type":["string","null"],"readOnly":true,"maxLength":50},"provider":{"type":["string","null"],"maxLength":255},"action_type":{"type":["string","null"],"maxLength":255},"action_description":{},"status":{"type":["string","null"],"default":"submitted","maxLength":255},"creation_time":{"type":"string","format":"date-time","readOnly":true},"execution_time":{"type":["string","null"],"format":"date-time","readOnly":true},"execution_info":{"readOnly":true},"exchange_status":{"type":["string","null"],"maxLength":255}},"additionalProperties":false},"LegacyPurchaseAction_Exclude_User":{"type":"object","properties":{"id":{"type":"string","readOnly":true,"maxLength":50},"org_id":{"type":["string","null"],"readOnly":true,"maxLength":50},"user_id":{"type":["string","null"],"readOnly":true,"maxLength":50},"provider":{"type":["string","null"],"maxLength":255},"action_type":{"type":["string","null"],"maxLength":255},"action_description":{},"status":{"type":["string","null"],"default":"submitted","maxLength":255},"creation_time":{"type":"string","format":"date-time","readOnly":true},"execution_time":{"type":["string","null"],"format":"date-time","readOnly":true},"execution_info":{"readOnly":true}},"additionalProperties":false}}}} ``` ## The UpdatePartnerOrg object ```json {"openapi":"3.1.0","info":{"title":"Archera.ai Channel Partner API","version":"v1.0.0"},"components":{"schemas":{"UpdatePartnerOrg":{"type":"object","properties":{"aws_marketplace_offer_link":{"type":["string","null"],"format":"url"},"azure_marketplace_offer_link":{"type":["string","null"],"format":"url"},"gcp_marketplace_offer_link":{"type":["string","null"],"format":"url"}},"additionalProperties":false}}}} ``` ## The PartnerOrgResponse object ```json {"openapi":"3.1.0","info":{"title":"Archera.ai Channel Partner API","version":"v1.0.0"},"components":{"schemas":{"PartnerOrgResponse":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"aws_marketplace_offer_link":{"type":["string","null"]},"azure_marketplace_offer_link":{"type":["string","null"]},"gcp_marketplace_offer_link":{"type":["string","null"]}},"required":["aws_marketplace_offer_link","azure_marketplace_offer_link","gcp_marketplace_offer_link","id","name"],"additionalProperties":false}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.archera.ai/api-reference/partner-api/models.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.