{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Property Usage and Credits","description":"Guides and API reference for the DataSift (REISift) Core API and SiftMap API."},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"property-usage-and-credits","__idx":0},"children":["Property Usage and Credits"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Property Usage tracks properties delivered to an account during its billing period. When credits are enabled, the monthly allowance is used first; Auto Use can pay for eligible properties after the allowance is exhausted. Auto Add can replenish the credit balance automatically."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/internal/"]}," endpoints below use the DataSift API authentication described in ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/guides/authentication"},"children":["Authentication"]},". The API reference lists the request and response schemas."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"endpoints","__idx":1},"children":["Endpoints"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Path"},"children":["Path"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Purpose"},"children":["Purpose"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/internal/credits/settings/"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read Auto Use and Auto Add settings (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["billing_read"]},")"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["PATCH"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/internal/credits/settings/"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update Auto Use and Auto Add settings (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["credits_write"]},")"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["POST"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/internal/property-usage/view/"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Meter a SiftMap property detail view"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/internal/credits/history/"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List credit transactions (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["billing_read"]},")"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/internal/credits/history/{uuid}/receipt/"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Get a card transaction's Stripe receipt (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["billing_read"]},")"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/internal/property-usage/history/"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List property usage events"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/internal/property-usage/history/{uuid}/fetched-properties/"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List the properties delivered by a usage event"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/internal/account/details/"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read account details, including ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["property_usage"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["POST"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/internal/upload/usage/"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read upload usage and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["property_usage"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Credit settings and credit history require a valid account. Credit history and receipts additionally require ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["billing_read"]},"; changing settings requires ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["credits_write"]},". For property usage history, callers with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["billing_read"]}," see all account events; other callers see only their own events."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"usage-summary","__idx":2},"children":["Usage summary"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Account details and upload usage include a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["property_usage"]}," object. When credits are disabled for the account, it is:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\"credits_enabled\": false}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When enabled, the object includes the billing period and renewal date, properties used and allowance remaining, overage rate and balance, Auto Use/Auto Add state, and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["usage_state"]},". Its values are:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"usage_state"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["usage_state"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Meaning"},"children":["Meaning"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["normal"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Usage is below the warning threshold"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["warning"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Usage has reached the configured warning threshold"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reached_blocked"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Allowance is exhausted and another property cannot be paid for"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reached_billing"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Allowance is exhausted and Auto Use can pay for additional properties"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["low_balance"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Allowance is exhausted, Auto Use is active, and balance is low"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["limit"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["allowance_left"]}," are null when the account's plan has no allowance limit. Monetary values are returned as decimal strings."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/internal/upload/usage/"]}," accepts an optional ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["storage_key"]},". When supplied, the response also includes ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["line_count"]}," for that CSV."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"credit-settings","__idx":3},"children":["Credit settings"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Read settings with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/internal/credits/settings/"]},". If settings have never been saved, the endpoint returns defaults without creating a database record."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH /api/internal/credits/settings/"]}," to change only the supplied fields:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"auto_use_enabled\": true,\n  \"auto_add_enabled\": true,\n  \"auto_add_threshold\": \"5.00\",\n  \"auto_add_amount\": \"25.00\",\n  \"auto_add_payment_method_id\": \"pm_example\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Enabling Auto Add requires a threshold, a top-up amount at or above the configured credit minimum, and an account-owned Stripe payment method. Disabling Auto Add clears its saved payment method. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["auto_add_failed_at"]}," is read-only."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"metering-a-siftmap-detail-view","__idx":4},"children":["Metering a SiftMap detail view"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Before returning full SiftMap property details, call ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/internal/property-usage/view/"]}," with the property's ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dataflik_id"]},":"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\"dataflik_id\": 123456}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The response reports ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["out_of_usage"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["auto_use_required"]},", credit amounts, usage consumed/used/limit, and the resulting ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["usage_state"]},". Already-owned properties and properties fetched earlier in the current period do not incur another charge. When ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["out_of_usage"]}," is true, the SiftMap client should return basic details only. If credits are disabled, the credit and usage figures are null."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The history endpoints accept inclusive ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["start_date"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["end_date"]}," filters. Date-only values cover the full US Central calendar day; offset-free datetimes are interpreted as US Central. Both history lists are paginated. Usage event rows identify the actor and API-key type when available; the fetched-properties endpoint lists each property first delivered by that event, with its Dataflik ID, address, APN, and timestamp."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"property-creation-and-metering-responses","__idx":5},"children":["Property creation and metering responses"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The metered public ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /property/"]}," route is a separate integration endpoint protected by a Zapier-specific API key; it is ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["not"]}," an OpenAPI-key endpoint. When Property Usage Credits are enabled, successful metered responses include:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Header"},"children":["Header"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Meaning"},"children":["Meaning"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X-Credits-Consumed"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Dollars consumed by the request"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X-Credits-Remaining"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Credit balance after the request"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X-Usage-Consumed"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Properties added to the usage counter"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X-Usage-Used"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Usage counter after the request"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X-Usage-Limit"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Period limit; omitted when the plan has no limit"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X-Usage-State"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Usage state after the request"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When the allowance is exhausted and the request cannot be met, the endpoint returns HTTP ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["402"]},". Its JSON ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["code"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["auto_use_required"]}," when Auto Use is off, or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["insufficient_credits"]}," when the available credit balance cannot pay. The legacy upload-limit response remains in effect for accounts without Property Usage Credits."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["These headers and 402 behavior apply to metered create requests, not to the read-only usage summary or the SiftMap view-metering endpoint."]}]},"headings":[{"value":"Property Usage and Credits","id":"property-usage-and-credits","depth":1},{"value":"Endpoints","id":"endpoints","depth":2},{"value":"Usage summary","id":"usage-summary","depth":2},{"value":"Credit settings","id":"credit-settings","depth":2},{"value":"Metering a SiftMap detail view","id":"metering-a-siftmap-detail-view","depth":2},{"value":"Property creation and metering responses","id":"property-creation-and-metering-responses","depth":2}],"frontmatter":{"seo":{"title":"Property Usage and Credits"}},"lastModified":"2026-11-12T17:07:27.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/guides/property-usage-and-credits","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}