FrameSDK/com.framepayments.framesdk.subscriptions/SubscriptionEndpoints/SearchSubscriptions

SearchSubscriptions

data class SearchSubscriptions(val status: String? = null, val createdBefore: Int? = null, val createdAfter: Int? = null) : SubscriptionEndpoints

Endpoint for searching subscriptions via GET to /v1/subscriptions/search.

Constructors

Link copied to clipboard
constructor(status: String? = null, createdBefore: Int? = null, createdAfter: Int? = null)

Properties

Link copied to clipboard
open val additionalHeaders: Map<String, String>

Optional extra HTTP headers to attach to the request (e.g. Accept: application/json). Defaults to empty. Applied after the standard Frame Authorization/User-Agent headers but before Content-Type (set on POST/PATCH), so an entry may override the former but not the latter. Prefer supplemental headers like Accept; don't rely on this to set auth headers.

Link copied to clipboard
val createdAfter: Int? = null

Optional Unix timestamp; returns subscriptions created after this time.

Link copied to clipboard
val createdBefore: Int? = null

Optional Unix timestamp; returns subscriptions created before this time.

Link copied to clipboard
open override val endpointURL: String

The fully qualified URL string for this endpoint.

Link copied to clipboard
open override val httpMethod: String

HTTP method, e.g. "GET", "POST", "DELETE".

Link copied to clipboard
open override val queryItems: List<QueryItem>?

Optional query-string parameters appended to endpointURL.

Link copied to clipboard
val status: String? = null

Optional subscription status to filter by (e.g., "active", "cancelled").