--- title: "Get company native subscription" method: GET path: "/companies/{company_id}/native-subscription" tags: ["billing"] --- # Get company native subscription `GET /companies/{company_id}/native-subscription` ## Request - Base URL: `https://api.schematichq.com` - URL: `https://api.schematichq.com/companies/{company_id}/native-subscription` - Auth: API key in header `X-Schematic-Api-Key` ## Path parameters - `company_id` string, required ## Response `200` OK - object - `data` BillingNativeSubscriptionResponseData, required - `cancel_at` string, date-time, nullable - `company_id` string, required - `currency` 'aed' | 'afn' | 'all' | 'amd' | 'ang' | 'aoa' | 'ars' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bif' | 'bmd' | 'bnd' | 'bob' | 'brl' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'cad' | 'cdf' | 'chf' | 'clp' | 'cny' | 'cop' | 'crc' | 'cve' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'fkp' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gyd' | 'hkd' | 'hnl' | 'htg' | 'huf' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mur' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nio' | 'nok' | 'npr' | 'nzd' | 'pab' | 'pen' | 'pgk' | 'php' | 'pkr' | 'pln' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'shp' | 'sle' | 'sos' | 'srd' | 'std' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'twd' | 'tzs' | 'uah' | 'ugx' | 'usd' | 'uyu' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'xcg' | 'xof' | 'xpf' | 'yer' | 'zar' | 'zmw', required - `id` string, required - `lines` BillingNativeSubscriptionLineResponseData[], required: The lines in effect now. - `anchor` string, date-time, required - `anchor_day` integer, required: The day of the month the line's periods start on. - `base` boolean, required: Whether the subscription takes its billing period from this line. - `cadence_count` integer, required - `cadence_unit` 'day' | 'month' | 'one-time' | 'year', required - `currency` 'aed' | 'afn' | 'all' | 'amd' | 'ang' | 'aoa' | 'ars' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bif' | 'bmd' | 'bnd' | 'bob' | 'brl' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'cad' | 'cdf' | 'chf' | 'clp' | 'cny' | 'cop' | 'crc' | 'cve' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'fkp' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gyd' | 'hkd' | 'hnl' | 'htg' | 'huf' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mur' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nio' | 'nok' | 'npr' | 'nzd' | 'pab' | 'pen' | 'pgk' | 'php' | 'pkr' | 'pln' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'shp' | 'sle' | 'sos' | 'srd' | 'std' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'twd' | 'tzs' | 'uah' | 'ugx' | 'usd' | 'uyu' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'xcg' | 'xof' | 'xpf' | 'yer' | 'zar' | 'zmw', required - `current_period_end` string, date-time, nullable: Null on a line that hasn't started. - `current_period_start` string, date-time, nullable: Null on a line that hasn't started. - `effective_from` string, date-time, required - `effective_to` string, date-time, nullable - `feature_name` string, nullable: The feature the line bills for when its price belongs to a plan entitlement, such as seats. Null on a plan's own price, an add-on's and a credit's. - `id` string, required - `kind` 'allowance' | 'capacity' | 'rate', required - `quantity` integer, required - `source_id` string, required: The plan, add-on or plan credit grant the line compiles from. - `source_name` string, nullable: The name of the plan, add-on or credit the line compiles from. - `source_plan_type` 'plan' | 'add_on' - `taxable` boolean, required - `tiers_mode` 'graduated' | 'volume' - `timing` 'in_advance' | 'in_arrears', required - `unit_amount` integer, nullable: In minor units. Null on a rate line or a tiered price. - `period_end` string, date-time, required - `period_start` string, date-time, required - `scheduled_changes` BillingNativeSubscriptionChangeResponseData[], required: Changes that take effect later, earliest first. - `action` 'add' | 'cancel' | 'remove' | 'replace', required - `effective_at` string, date-time, required - `line` BillingNativeSubscriptionLineResponseData - `anchor` string, date-time, required - `anchor_day` integer, required: The day of the month the line's periods start on. - `base` boolean, required: Whether the subscription takes its billing period from this line. - `cadence_count` integer, required - `cadence_unit` 'day' | 'month' | 'one-time' | 'year', required - `currency` 'aed' | 'afn' | 'all' | 'amd' | 'ang' | 'aoa' | 'ars' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bif' | 'bmd' | 'bnd' | 'bob' | 'brl' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'cad' | 'cdf' | 'chf' | 'clp' | 'cny' | 'cop' | 'crc' | 'cve' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'fkp' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gyd' | 'hkd' | 'hnl' | 'htg' | 'huf' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mur' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nio' | 'nok' | 'npr' | 'nzd' | 'pab' | 'pen' | 'pgk' | 'php' | 'pkr' | 'pln' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'shp' | 'sle' | 'sos' | 'srd' | 'std' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'twd' | 'tzs' | 'uah' | 'ugx' | 'usd' | 'uyu' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'xcg' | 'xof' | 'xpf' | 'yer' | 'zar' | 'zmw', required - `current_period_end` string, date-time, nullable: Null on a line that hasn't started. - `current_period_start` string, date-time, nullable: Null on a line that hasn't started. - `effective_from` string, date-time, required - `effective_to` string, date-time, nullable - `feature_name` string, nullable: The feature the line bills for when its price belongs to a plan entitlement, such as seats. Null on a plan's own price, an add-on's and a credit's. - `id` string, required - `kind` 'allowance' | 'capacity' | 'rate', required - `quantity` integer, required - `source_id` string, required: The plan, add-on or plan credit grant the line compiles from. - `source_name` string, nullable: The name of the plan, add-on or credit the line compiles from. - `source_plan_type` 'plan' | 'add_on' - `taxable` boolean, required - `tiers_mode` 'graduated' | 'volume' - `timing` 'in_advance' | 'in_arrears', required - `unit_amount` integer, nullable: In minor units. Null on a rate line or a tiered price. - `replaces` BillingNativeSubscriptionLineResponseData - `anchor` string, date-time, required - `anchor_day` integer, required: The day of the month the line's periods start on. - `base` boolean, required: Whether the subscription takes its billing period from this line. - `cadence_count` integer, required - `cadence_unit` 'day' | 'month' | 'one-time' | 'year', required - `currency` 'aed' | 'afn' | 'all' | 'amd' | 'ang' | 'aoa' | 'ars' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bif' | 'bmd' | 'bnd' | 'bob' | 'brl' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'cad' | 'cdf' | 'chf' | 'clp' | 'cny' | 'cop' | 'crc' | 'cve' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'fkp' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gyd' | 'hkd' | 'hnl' | 'htg' | 'huf' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mur' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nio' | 'nok' | 'npr' | 'nzd' | 'pab' | 'pen' | 'pgk' | 'php' | 'pkr' | 'pln' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'shp' | 'sle' | 'sos' | 'srd' | 'std' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'twd' | 'tzs' | 'uah' | 'ugx' | 'usd' | 'uyu' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'xcg' | 'xof' | 'xpf' | 'yer' | 'zar' | 'zmw', required - `current_period_end` string, date-time, nullable: Null on a line that hasn't started. - `current_period_start` string, date-time, nullable: Null on a line that hasn't started. - `effective_from` string, date-time, required - `effective_to` string, date-time, nullable - `feature_name` string, nullable: The feature the line bills for when its price belongs to a plan entitlement, such as seats. Null on a plan's own price, an add-on's and a credit's. - `id` string, required - `kind` 'allowance' | 'capacity' | 'rate', required - `quantity` integer, required - `source_id` string, required: The plan, add-on or plan credit grant the line compiles from. - `source_name` string, nullable: The name of the plan, add-on or credit the line compiles from. - `source_plan_type` 'plan' | 'add_on' - `taxable` boolean, required - `tiers_mode` 'graduated' | 'volume' - `timing` 'in_advance' | 'in_arrears', required - `unit_amount` integer, nullable: In minor units. Null on a rate line or a tiered price. - `started_at` string, date-time, nullable - `statement` BillingStatementResponseData - `currency` 'aed' | 'afn' | 'all' | 'amd' | 'ang' | 'aoa' | 'ars' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bif' | 'bmd' | 'bnd' | 'bob' | 'brl' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'cad' | 'cdf' | 'chf' | 'clp' | 'cny' | 'cop' | 'crc' | 'cve' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'fkp' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gyd' | 'hkd' | 'hnl' | 'htg' | 'huf' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mur' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nio' | 'nok' | 'npr' | 'nzd' | 'pab' | 'pen' | 'pgk' | 'php' | 'pkr' | 'pln' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'shp' | 'sle' | 'sos' | 'srd' | 'std' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'twd' | 'tzs' | 'uah' | 'ugx' | 'usd' | 'uyu' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'xcg' | 'xof' | 'xpf' | 'yer' | 'zar' | 'zmw', required - `lines` BillingStatementLineResponseData[], required - `amount` integer, required: In minor units of the statement's currency. - `kind` 'adjustment' | 'purchase' | 'reconciliation' | 'subscription' | 'true_up', required - `period_end` string, date-time, nullable - `period_start` string, date-time, nullable - `quantity` integer, nullable - `subscription_line_id` string, nullable - `unit_amount` integer, nullable - `period_end` string, date-time, required: When the statement was read; it keeps growing until the period closes. - `period_start` string, date-time, required: The earliest open charge, or period_end when there is none. - `subtotal` integer, required - `total` integer, required - `status` 'active' | 'canceled' | 'expired' | 'incomplete' | 'incomplete_expired' | 'past_due' | 'paused' | 'trialing' | 'unpaid', required - `terms` BillingInvoiceTermsResponseData - `billing_details` BillingInvoiceBillingDetailsResponseData - `address` BillingInvoiceAddressResponseData - `city` string, required - `country` string, required - `line1` string, required - `line2` string, required - `postal_code` string, required - `state` string, required - `email` string, nullable - `phone` string, nullable - `tax_ids` BillingInvoiceTaxIDResponseData[], required - `type` 'ae_trn' | 'au_abn' | 'au_arn' | 'br_cnpj' | 'br_cpf' | 'ca_bn' | 'ca_gst_hst' | 'ca_pst_bc' | 'ca_pst_mb' | 'ca_pst_sk' | 'ca_qst' | 'ch_uid' | 'ch_vat' | 'eu_vat' | 'gb_vat' | 'hk_br' | 'id_npwp' | 'il_vat' | 'in_gst' | 'jp_cn' | 'jp_rn' | 'jp_trn' | 'kr_brn' | 'mx_rfc' | 'my_frp' | 'my_itn' | 'my_sst' | 'no_vat' | 'nz_gst' | 'ph_tin' | 'sa_vat' | 'sg_gst' | 'sg_uen' | 'th_vat' | 'tr_tin' | 'tw_vat' | 'us_ein' | 'za_vat', required - `value` string, required - `collection_method` 'charge_automatically' | 'send_invoice', required - `collector` 'external' | 'stripe_invoice' | 'stripe_payments', required - `currency` 'aed' | 'afn' | 'all' | 'amd' | 'ang' | 'aoa' | 'ars' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bif' | 'bmd' | 'bnd' | 'bob' | 'brl' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'cad' | 'cdf' | 'chf' | 'clp' | 'cny' | 'cop' | 'crc' | 'cve' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'fkp' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gyd' | 'hkd' | 'hnl' | 'htg' | 'huf' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mur' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nio' | 'nok' | 'npr' | 'nzd' | 'pab' | 'pen' | 'pgk' | 'php' | 'pkr' | 'pln' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'shp' | 'sle' | 'sos' | 'srd' | 'std' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'twd' | 'tzs' | 'uah' | 'ugx' | 'usd' | 'uyu' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'xcg' | 'xof' | 'xpf' | 'yer' | 'zar' | 'zmw' - `days_until_due` integer, nullable - `payment_gating` 'keep_serving' | 'revoke_after', required - `purchase_order` string, nullable - `params` object, required: Input parameters ## Other responses - `401`: Unauthorized - `403`: Forbidden - `404`: Not found - `500`: Server error ## Changes > 230 revisions in range; 1 not diffed. - **2026-10-27** `dfc5885080fb`: 3 info - added the optional property `data/lines/items/feature_name` to the response with the `200` status - added the optional property `data/scheduled_changes/items/line/allOf[subschema #1: BillingNativeSubscriptionLineResponseData]/feature_name` to the response with the `200` status - added the optional property `data/scheduled_changes/items/replaces/allOf[subschema #1: BillingNativeSubscriptionLineResponseData]/feature_name` to the response with the `200` status - **2026-10-21** `67a1a6df05fe`: 1 info - added the optional property `data/terms/allOf[subschema #1: BillingInvoiceTermsResponseData]/billing_details` to the response with the `200` status - **2026-10-15** `7bd3378c16b1`: 1 info - endpoint added [Operation history](https://skmtc.dev/schematichq/apis/schematic-api/changes/companies/:company_id/native-subscription/get.md) --- [API](https://skmtc.dev/schematichq/apis/schematic-api.md) - [All operations](https://skmtc.dev/schematichq/apis/schematic-api/llms.txt) - [OpenAPI document](https://skmtc.dev/schematichq/apis/schematic-api/revisions/64cb7e17c236?raw)